URI HTTP methods Schemas Properties See also

Entitlements: grant

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`	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`	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 Support.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Request bodies


{
  "entitlements": [
    {
      "entitlementStatus": enum,
      "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


{
  "entitlements": [
    {
      "entitlementStatus": enum,
      "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"
}


{
  "message": "string"
}

Properties

Encryption

Information about the encryption of the flow.

Property	Type	Required	Description
`resourceId`	string	False	An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
`roleArn`	string	True	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up MediaConnect as a trusted entity).
`secretArn`	string	False	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
`constantInitializationVector`	string	False	A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
`keyType`	string Values: `speke \| static-key \| srt-password`	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`).
`region`	string	False	The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
`deviceId`	string	False	The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
`url`	string	False	The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
`algorithm`	string Values: `aes128 \| aes192 \| aes256`	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

Entitlement

The settings for a flow entitlement.

Property	Type	Required	Description
`entitlementStatus`	string Values: `ENABLED \| DISABLED`	False	An indication of whether the entitlement is enabled.
`encryption`	Encryption	False	The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
`subscribers`	Array of type string	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 MediaConnect console and is not visible outside of the current AWS account.
`dataTransferSubscriberFeePercent`	integer	False	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.
`entitlementArn`	string	True	The ARN of the entitlement.

GrantEntitlementRequest

The entitlements that you want to grant on the flow.

Property	Type	Required	Description
`entitlementStatus`	string Values: `ENABLED \| DISABLED`	False	An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
`encryption`	Encryption	False	The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
`subscribers`	Array of type string	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 MediaConnect console and is not visible outside of the current AWS account.
`dataTransferSubscriberFeePercent`	integer	False	The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for.

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 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 MediaConnect returns to help you understand the reason that the request did not succeed.