- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
RevokeFlowEntitlementCommand
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaConnectClient, RevokeFlowEntitlementCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import
// const { MediaConnectClient, RevokeFlowEntitlementCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import
const client = new MediaConnectClient(config);
const input = { // RevokeFlowEntitlementRequest
EntitlementArn: "STRING_VALUE", // required
FlowArn: "STRING_VALUE", // required
};
const command = new RevokeFlowEntitlementCommand(input);
const response = await client.send(command);
// { // RevokeFlowEntitlementResponse
// EntitlementArn: "STRING_VALUE",
// FlowArn: "STRING_VALUE",
// };
RevokeFlowEntitlementCommand Input
See RevokeFlowEntitlementCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
EntitlementArnRequired | string | undefined | The ARN of the entitlement that you want to revoke. |
FlowArnRequired | string | undefined | The flow that you want to revoke an entitlement from. |
RevokeFlowEntitlementCommand Output
See RevokeFlowEntitlementCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
EntitlementArn | string | undefined | The ARN of the entitlement that was revoked. |
FlowArn | string | undefined | The ARN of the flow that the entitlement was revoked from. |
Throws
Name | Fault | Details |
|---|
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. |