entitlements

Creates, updates, deletes, gets or lists an entitlements resource.

Overview

Name	entitlements
Type	Resource
Id	aws.mediaconnect.entitlements

Fields

The following fields are returned by SELECT queries:

list_entitlements

Name	Datatype	Description
data_transfer_subscriber_fee_percent	integer	Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
entitlement_arn	string	The ARN of the entitlement.
entitlement_name	string	The name of the entitlement.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_entitlements	select	region	maxResults, nextToken	Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
revoke_flow_entitlement	update	entitlement_arn, flow_arn, region		Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
grant_flow_entitlements	exec	flow_arn, region		Grants entitlements to an existing flow.
update_flow_entitlement	exec	entitlement_arn, flow_arn, region		Updates an entitlement. You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
entitlement_arn	string	The Amazon Resource Name (ARN) of the entitlement that you want to update.
flow_arn	string	The ARN of the flow that is associated with the entitlement that you want to update.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per API request. For example, you submit a ListEntitlements request with set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
nextToken	string	The token that identifies the batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

SELECT examples

list_entitlements

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

SELECT
data_transfer_subscriber_fee_percent,
entitlement_arn,
entitlement_name
FROM aws.mediaconnect.entitlements
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

revoke_flow_entitlement

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

UPDATE aws.mediaconnect.entitlements
SET 
-- No updatable properties
WHERE 
entitlement_arn = '{{ entitlement_arn }}' --required
AND flow_arn = '{{ flow_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
entitlement_arn,
flow_arn;

Lifecycle Methods

grant_flow_entitlements

Grants entitlements to an existing flow.

EXEC aws.mediaconnect.entitlements.grant_flow_entitlements 
@flow_arn='{{ flow_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Entitlements": "{{ Entitlements }}"
}'
;

update_flow_entitlement

Updates an entitlement. You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

EXEC aws.mediaconnect.entitlements.update_flow_entitlement 
@entitlement_arn='{{ entitlement_arn }}' --required, 
@flow_arn='{{ flow_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Description": "{{ Description }}", 
"Encryption": "{{ Encryption }}", 
"EntitlementStatus": "{{ EntitlementStatus }}", 
"Subscribers": "{{ Subscribers }}"
}'
;