UpdateFlowEntitlementCommand

Suggest an Edit
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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MediaConnectClient, UpdateFlowEntitlementCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import
// const { MediaConnectClient, UpdateFlowEntitlementCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import
const client = new MediaConnectClient(config);
const input = { // UpdateFlowEntitlementRequest
  Description: "STRING_VALUE",
  Encryption: { // UpdateEncryption
    Algorithm: "aes128" || "aes192" || "aes256",
    ConstantInitializationVector: "STRING_VALUE",
    DeviceId: "STRING_VALUE",
    KeyType: "speke" || "static-key" || "srt-password",
    Region: "STRING_VALUE",
    ResourceId: "STRING_VALUE",
    RoleArn: "STRING_VALUE",
    SecretArn: "STRING_VALUE",
    Url: "STRING_VALUE",
  },
  EntitlementArn: "STRING_VALUE", // required
  EntitlementStatus: "ENABLED" || "DISABLED",
  FlowArn: "STRING_VALUE", // required
  Subscribers: [ // __listOf__string
    "STRING_VALUE",
  ],
};
const command = new UpdateFlowEntitlementCommand(input);
const response = await client.send(command);
// { // UpdateFlowEntitlementResponse
//   Entitlement: { // Entitlement
//     DataTransferSubscriberFeePercent: Number("int"),
//     Description: "STRING_VALUE",
//     Encryption: { // Encryption
//       Algorithm: "aes128" || "aes192" || "aes256",
//       ConstantInitializationVector: "STRING_VALUE",
//       DeviceId: "STRING_VALUE",
//       KeyType: "speke" || "static-key" || "srt-password",
//       Region: "STRING_VALUE",
//       ResourceId: "STRING_VALUE",
//       RoleArn: "STRING_VALUE", // required
//       SecretArn: "STRING_VALUE",
//       Url: "STRING_VALUE",
//     },
//     EntitlementArn: "STRING_VALUE", // required
//     EntitlementStatus: "ENABLED" || "DISABLED",
//     Name: "STRING_VALUE", // required
//     Subscribers: [ // __listOf__string // required
//       "STRING_VALUE",
//     ],
//   },
//   FlowArn: "STRING_VALUE",
// };

UpdateFlowEntitlementCommand Input

See UpdateFlowEntitlementCommandInput for more details

Parameter
Type
Description
EntitlementArn
Required
string | undefined
The ARN of the entitlement that you want to update.
FlowArn
Required
string | undefined
The flow that is associated with the entitlement that you want to update.
Description
string | undefined
A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
Encryption
UpdateEncryption | undefined
The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.
EntitlementStatus
EntitlementStatus | undefined
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.
Subscribers
string[] | undefined
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.

UpdateFlowEntitlementCommand Output

See UpdateFlowEntitlementCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Entitlement
Entitlement | undefined
The new configuration of the entitlement that you updated.
FlowArn
string | undefined
The ARN of the flow that this entitlement was granted on.

Throws

Name
Fault
Details
BadRequestException
client
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ForbiddenException
client
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
InternalServerErrorException
server
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
NotFoundException
client
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ServiceUnavailableException
server
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
TooManyRequestsException
client
Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
MediaConnectServiceException
Base exception class for all service exceptions from MediaConnect service.