The Entitlements API from Amazon MediaConnect — 1 operation(s) for entitlements.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-mediaconnect:amazon-mediaconnect-entitlements-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: AWS MediaConnect Entitlements API
version: '2018-11-14'
description: Generated from AWS's published Smithy model for AWS MediaConnect. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://mediaconnect.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/v1/entitlements:
get:
operationId: ListEntitlements
summary: List Entitlements
description: Displays a list of all entitlements that have been granted to this account. This request returns 20 results
per page.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEntitlementsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListEntitlementsRequest'
tags:
- Entitlements
/v1/flows/{FlowArn}/entitlements:
post:
operationId: GrantFlowEntitlements
summary: Grant Flow Entitlements
description: Grants entitlements to an existing flow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GrantFlowEntitlementsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'420':
description: GrantFlowEntitlements420Exception
content:
application/json:
schema:
$ref: '#/components/schemas/GrantFlowEntitlements420Exception'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GrantFlowEntitlementsRequest'
tags:
- Entitlements
/v1/flows/{FlowArn}/entitlements/{EntitlementArn}:
delete:
operationId: RevokeFlowEntitlement
summary: Revoke Flow Entitlement
description: Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to
the subscriber and the associated output is removed.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeFlowEntitlementResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeFlowEntitlementRequest'
tags:
- Entitlements
put:
operationId: UpdateFlowEntitlement
summary: Update Flow Entitlement
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlowEntitlementResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlowEntitlementRequest'
tags:
- Entitlements
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: mediaconnect
schemas:
BadRequestException:
type: object
properties:
Message:
type: string
required:
- Message
Encryption:
type: object
properties:
Algorithm:
type: string
enum:
- aes128
- aes192
- aes256
description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector:
type: string
description: 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:
type: string
description: 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:
type: string
enum:
- speke
- static-key
- srt-password
description: The type of key that is used for the encryption. If no keyType is provided, the service will use the
default setting (static-key).
Region:
type: string
description: The Amazon Web Services 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:
type: string
description: 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:
type: string
description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
SecretArn:
type: string
description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter
is required for static key encryption and is not valid for SPEKE encryption.
Url:
type: string
description: 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.
required:
- RoleArn
Entitlement:
type: object
properties:
DataTransferSubscriberFeePercent:
type: integer
description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description:
type: string
description: A description of the entitlement.
Encryption:
$ref: '#/components/schemas/Encryption'
EntitlementArn:
type: string
description: The ARN of the entitlement.
EntitlementStatus:
type: string
enum:
- ENABLED
- DISABLED
description: An indication of whether the entitlement is enabled.
Name:
type: string
description: The name of the entitlement.
Subscribers:
type: array
items:
type: string
description: The Amazon Web Services 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.
required:
- EntitlementArn
- Name
- Subscribers
ForbiddenException:
type: object
properties:
Message:
type: string
required:
- Message
GrantEntitlementRequest:
type: object
properties:
DataTransferSubscriberFeePercent:
type: integer
description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description:
type: string
description: A description of the entitlement. This description appears only on the MediaConnect console and will
not be seen by the subscriber or end user.
Encryption:
$ref: '#/components/schemas/Encryption'
EntitlementStatus:
type: string
enum:
- ENABLED
- DISABLED
description: 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.
Name:
type: string
description: The name of the entitlement. This value must be unique within the current flow.
Subscribers:
type: array
items:
type: string
description: The Amazon Web Services 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.
EntitlementTags:
type: object
additionalProperties:
type: string
description: The key-value pairs that can be used to tag and organize the entitlement.
required:
- Subscribers
GrantFlowEntitlements420Exception:
type: object
properties:
Message:
type: string
required:
- Message
GrantFlowEntitlementsRequest:
type: object
properties:
Entitlements:
type: array
items:
$ref: '#/components/schemas/GrantEntitlementRequest'
description: The list of entitlements that you want to grant.
FlowArn:
type: string
description: The Amazon Resource Name (ARN) of the flow that you want to grant entitlements on.
required:
- Entitlements
- FlowArn
GrantFlowEntitlementsResponse:
type: object
properties:
Entitlements:
type: array
items:
$ref: '#/components/schemas/Entitlement'
description: The entitlements that were just granted.
FlowArn:
type: string
description: The ARN of the flow that these entitlements were granted to.
InternalServerErrorException:
type: object
properties:
Message:
type: string
required:
- Message
ListEntitlementsRequest:
type: object
properties:
MaxResults:
type: integer
description: 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:
type: string
description: 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.
ListEntitlementsResponse:
type: object
properties:
Entitlements:
type: array
items:
$ref: '#/components/schemas/ListedEntitlement'
description: A list of entitlements that have been granted to you from other Amazon Web Services accounts.
NextToken:
type: string
description: 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.
ListedEntitlement:
type: object
properties:
DataTransferSubscriberFeePercent:
type: integer
description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
EntitlementArn:
type: string
description: The ARN of the entitlement.
EntitlementName:
type: string
description: The name of the entitlement.
required:
- EntitlementArn
- EntitlementName
NotFoundException:
type: object
properties:
Message:
type: string
required:
- Message
RevokeFlowEntitlementRequest:
type: object
properties:
EntitlementArn:
type: string
description: The Amazon Resource Name (ARN) of the entitlement that you want to revoke.
FlowArn:
type: string
description: The flow that you want to revoke an entitlement from.
required:
- EntitlementArn
- FlowArn
RevokeFlowEntitlementResponse:
type: object
properties:
EntitlementArn:
type: string
description: The ARN of the entitlement that was revoked.
FlowArn:
type: string
description: The ARN of the flow that the entitlement was revoked from.
ServiceUnavailableException:
type: object
properties:
Message:
type: string
required:
- Message
TooManyRequestsException:
type: object
properties:
Message:
type: string
required:
- Message
UpdateEncryption:
type: object
properties:
Algorithm:
type: string
enum:
- aes128
- aes192
- aes256
description: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector:
type: string
description: 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:
type: string
description: 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:
type: string
enum:
- speke
- static-key
- srt-password
description: The type of key that is used for the encryption. If no keyType is provided, the service will use the
default setting (static-key).
Region:
type: string
description: The Amazon Web Services 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:
type: string
description: 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:
type: string
description: The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
SecretArn:
type: string
description: The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter
is required for static key encryption and is not valid for SPEKE encryption.
Url:
type: string
description: 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:
type: object
properties:
Description:
type: string
description: A description of the entitlement. This description appears only on the MediaConnect console and will
not be seen by the subscriber or end user.
Encryption:
$ref: '#/components/schemas/UpdateEncryption'
EntitlementArn:
type: string
description: The Amazon Resource Name (ARN) of the entitlement that you want to update.
EntitlementStatus:
type: string
enum:
- ENABLED
- DISABLED
description: An indication of whether you want to enable the entitlement to allow access, or disable 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.
FlowArn:
type: string
description: The ARN of the flow that is associated with the entitlement that you want to update.
Subscribers:
type: array
items:
type: string
description: The Amazon Web Services 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.
required:
- EntitlementArn
- FlowArn
UpdateFlowEntitlementResponse:
type: object
properties:
Entitlement:
$ref: '#/components/schemas/Entitlement'
FlowArn:
type: string
description: The ARN of the flow that this entitlement was granted on.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)