Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class UpdateFlowEntitlementCommandProtected

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

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",
// };

Param

UpdateFlowEntitlementCommandInput

Returns

UpdateFlowEntitlementCommandOutput

See

Throws

BadRequestException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

ForbiddenException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

InternalServerErrorException (server fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

NotFoundException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

ServiceUnavailableException (server fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

TooManyRequestsException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

MediaConnectServiceException

Base exception class for all service exceptions from MediaConnect service.

Hierarchy

Constructors

Properties

Methods