URI HTTP methods Schemas Properties See also

Entitlements: update, revoke

URI

/v1/flows/flowArn/entitlements/entitlementArn

HTTP methods

PUT

Operation ID: UpdateFlowEntitlement

Changes an entitlement on a flow. You can change an entitlement's description, subscriber account ID, and encryption. If you change the subscriber account ID, the service will remove the output that was generated when the original subscriber set up their flow.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.
`entitlementArn`	String	True	The ARN of the entitlement that you want to update.

Responses
Status code	Response model	Description
`202`	`UpdateFlowEntitlementResponse`	MediaConnect is updating the entitlement.
`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.
`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.

DELETE

Operation ID: RevokeFlowEntitlement

Revokes an entitlement from a flow. When you revoke an entitlement is revoked, the content becomes unavailable to the subscriber and MediaConnect removes the associated output.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.
`entitlementArn`	String	True	The ARN of the entitlement that you want to update.

Responses
Status code	Response model	Description
`202`	`RevokeFlowEntitlementResponse`	MediaConnect is revoking the entitlement.
`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.
`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


{
  "entitlementStatus": enum,
  "encryption": {
    "resourceId": "string",
    "roleArn": "string",
    "secretArn": "string",
    "constantInitializationVector": "string",
    "keyType": enum,
    "region": "string",
    "deviceId": "string",
    "url": "string",
    "algorithm": enum
  },
  "subscribers": [
    "string"
  ],
  "description": "string"
}

Response bodies


{
  "flowArn": "string",
  "entitlement": {
    "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",
  "entitlementArn": "string"
}


{
  "message": "string"
}

Properties

Encryption

Information about the encryption of the flow.

Property	Type	Required	Description
`algorithm`	string Values: `aes128 \| aes192 \| aes256`	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
`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.
`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.
`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.
`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.
`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.

Entitlement

The settings for a flow entitlement.

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

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.

RevokeFlowEntitlementResponse

The result of a successful RevokeFlowEntitlement request. The response includes the ARN of the flow and the ARN of the entitlement that you revoked.

Property	Type	Required	Description
`entitlementArn`	string	True	The ARN of the entitlement that you revoked.
`flowArn`	string	True	The ARN of the flow that the entitlement was revoked from.

UpdateEncryption

Information about the encryption of the flow.

Property	Type	Required	Description
`algorithm`	string Values: `aes128 \| aes192 \| aes256`	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
`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.
`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.
`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.
`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	False	The 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.
`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.

UpdateFlowEntitlementRequest

The updates that you want to make to a specific entitlement.

Property	Type	Required	Description
`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.
`encryption`	UpdateEncryption	False	The type of encryption that MediaConnect will use on the output that is associated with the entitlement.
`entitlementStatus`	string Values: `ENABLED \| DISABLED`	False	An indication of whether you want to activate the entitlement to allow access, or deactivate it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
`subscribers`	Array of type string	False	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.

UpdateFlowEntitlementResponse

The result of a successful UpdateFlowEntitlement request. The response includes the ARN of the flow that was updated and the updated entitlement configuration.

Property	Type	Required	Description
`entitlement`	Entitlement	True	The new configuration of the entitlement that you updated.
`flowArn`	string	True	The ARN of the flow that the entitlement was granted on.