AWS Elemental MediaConnect
API Reference

GrantFlowEntitlements

URI

/v1/flows/flowArn/entitlements

HTTP Methods

POST

Operation ID: GrantFlowEntitlements

Grants entitlements to an existing flow.

Path Parameters

Name Type Required Description
flowArn String True

The Amazon Resource Name (ARN) of the flow.

Responses

Status Code Response Model Description
200 GrantFlowEntitlementsResponse

AWS Elemental MediaConnect granted the entitlements successfully.

400 ResponseError

The request that you submitted is not valid.

403 ResponseError

You don't have the required permissions to perform this operation.

404 ResponseError

AWS Elemental MediaConnect did not find the resource that you specified in the request.

420 ResponseError

Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Customer Support.

429 ResponseError

You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

500 ResponseError

AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

AWS Elemental MediaConnect is currently unavailable. Try again later.

See Also

Schemas

Request Bodies

Example POST

{ "entitlements": [ { "encryption": { "roleArn": "string", "secretArn": "string", "keyType": enum, "algorithm": enum }, "subscribers": [ "string" ], "name": "string", "description": "string" } ] }

Response Bodies

Example GrantFlowEntitlementsResponse

{ "entitlements": [ { "encryption": { "roleArn": "string", "secretArn": "string", "keyType": enum, "algorithm": enum }, "subscribers": [ "string" ], "name": "string", "description": "string", "entitlementArn": "string" } ], "flowArn": "string" }

Example ResponseError

{ "message": "string" }

Properties

Encryption

Information about the encryption of the flow.

Property Type Required Description
roleArn

string

True

The Amazon Resource Name (ARN) of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

secretArn

string

True

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

keyType

string

Values: static-key

False

The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).

algorithm

string

Values: aes128 | aes192 | aes256

True

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

See Also

Entitlement

The settings for a flow entitlement.

Property Type Required Description
encryption

Encryption

False

The type of encryption that AWS Elemental MediaConnect will use on the output that is associated with the entitlement.

subscribers

array

True

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

name

string

True

The name of the entitlement.

description

string

False

A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and is not visible outside of the current AWS account.

entitlementArn

string

True

The ARN of the entitlement.

See Also

GrantEntitlementRequest

The entitlements that you want to grant on the flow.

Property Type Required Description
encryption

Encryption

False

The type of encryption that AWS Elemental MediaConnect will use on the output that is associated with the entitlement.

subscribers

array

True

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.

name

string

False

The name of the entitlement. This value must be unique within the current flow.

description

string

False

A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and is not visible outside of the current AWS account.

See Also

GrantFlowEntitlementsRequest

Grants an entitlement on a flow.

Property Type Required Description
entitlements

array

True

The list of entitlements that you want to grant.

See Also

GrantFlowEntitlementsResponse

The entitlements that you just granted.

Property Type Required Description
entitlements

array

True

The entitlements that were just granted.

flowArn

string

True

The ARN of the flow that these entitlements were granted to.

See Also

ResponseError

An exception raised by AWS Elemental MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property Type Required Description
message

string

True

The specific error message that AWS Elemental MediaConnect returns to help you understand the reason that the request did not succeed.

See Also