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. |
Schemas
Request Bodies
Example POST
{ "entitlements": [ { "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "subscribers": [ "string" ], "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer } ] }
Response Bodies
Example GrantFlowEntitlementsResponse
{ "entitlements": [ { "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "subscribers": [ "string" ], "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer, "entitlementArn": "string" } ], "flowArn": "string" }
Example ResponseError
{ "message": "string" }
Properties
Encryption
Information about the encryption of the flow.
Entitlement
The settings for a flow entitlement.
GrantEntitlementRequest
The entitlements that you want to grant on the flow.
GrantFlowEntitlementsRequest
Grants an entitlement on a flow.
Property | Type | Required | Description |
---|---|---|---|
entitlements |
Array of type GrantEntitlementRequest |
True |
The list of entitlements that you want to grant. |
GrantFlowEntitlementsResponse
The entitlements that you just granted.
Property | Type | Required | Description |
---|---|---|---|
entitlements |
Array of type Entitlement |
True |
The entitlements that were just granted. |
flowArn |
string |
True |
The ARN of the flow that these entitlements were granted to. |
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.
See Also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: