AWS MediaConnect 2018-11-14
- Client: Aws\MediaConnect\MediaConnectClient
- Service ID: mediaconnect
- Version: 2018-11-14
This page describes the parameters and results for the operations of the AWS MediaConnect (2018-11-14), and shows how to use the Aws\MediaConnect\MediaConnectClient object to call the described operations. This documentation is specific to the 2018-11-14 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AddFlowOutputs ( array $params = [] )
Adds outputs to an existing flow.
- CreateFlow ( array $params = [] )
Creates a new flow.
- DeleteFlow ( array $params = [] )
Deletes a flow.
- DescribeFlow ( array $params = [] )
Displays the details of a flow.
- GrantFlowEntitlements ( array $params = [] )
Grants entitlements to an existing flow.
- ListEntitlements ( array $params = [] )
Displays a list of all entitlements that have been granted to this account.
- ListFlows ( array $params = [] )
Displays a list of flows that are associated with this account.
- ListTagsForResource ( array $params = [] )
List all tags on an AWS Elemental MediaConnect resource
- RemoveFlowOutput ( array $params = [] )
Removes an output from an existing flow.
- RevokeFlowEntitlement ( array $params = [] )
Revokes an entitlement from a flow.
- StartFlow ( array $params = [] )
Starts a flow.
- StopFlow ( array $params = [] )
Stops a flow.
- TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
- UntagResource ( array $params = [] )
Deletes specified tags from a resource.
- UpdateFlowEntitlement ( array $params = [] )
You can change an entitlement's description, subscribers, and encryption.
- UpdateFlowOutput ( array $params = [] )
Updates an existing flow output.
- UpdateFlowSource ( array $params = [] )
Updates the source of a flow.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AddFlowOutputs
$result = $client->addFlowOutputs([/* ... */]); $promise = $client->addFlowOutputsAsync([/* ... */]);
Parameter Syntax
$result = $client->addFlowOutputs([
'FlowArn' => '<string>', // REQUIRED
'Outputs' => [ // REQUIRED
[
'Description' => '<string>',
'Destination' => '<string>', // REQUIRED
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256', // REQUIRED
'KeyType' => 'static-key',
'RoleArn' => '<string>', // REQUIRED
'SecretArn' => '<string>', // REQUIRED
],
'MaxLatency' => <integer>,
'Name' => '<string>',
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp', // REQUIRED
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
- Outputs
-
- Required: Yes
- Type: Array of AddOutputRequest structures
A list of outputs that you want to add.
Result Syntax
[
'FlowArn' => '<string>',
'Outputs' => [
[
'Description' => '<string>',
'Destination' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'MediaLiveInputArn' => '<string>',
'Name' => '<string>',
'OutputArn' => '<string>',
'Port' => <integer>,
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
],
// ...
],
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that these outputs were added to. - Outputs
-
- Type: Array of Output structures
The details of the newly added outputs.
Errors
-
AddFlowOutputs420Exception: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
CreateFlow
$result = $client->createFlow([/* ... */]); $promise = $client->createFlowAsync([/* ... */]);
Parameter Syntax
$result = $client->createFlow([
'AvailabilityZone' => '<string>',
'Entitlements' => [
[
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256', // REQUIRED
'KeyType' => 'static-key',
'RoleArn' => '<string>', // REQUIRED
'SecretArn' => '<string>', // REQUIRED
],
'Name' => '<string>',
'Subscribers' => ['<string>', ...], // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
'Outputs' => [
[
'Description' => '<string>',
'Destination' => '<string>', // REQUIRED
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256', // REQUIRED
'KeyType' => 'static-key',
'RoleArn' => '<string>', // REQUIRED
'SecretArn' => '<string>', // REQUIRED
],
'MaxLatency' => <integer>,
'Name' => '<string>',
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp', // REQUIRED
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
// ...
],
'Source' => [ // REQUIRED
'Decryption' => [
'Algorithm' => 'aes128|aes192|aes256', // REQUIRED
'KeyType' => 'static-key',
'RoleArn' => '<string>', // REQUIRED
'SecretArn' => '<string>', // REQUIRED
],
'Description' => '<string>',
'EntitlementArn' => '<string>',
'IngestPort' => <integer>,
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Name' => '<string>',
'Protocol' => 'zixi-push|rtp-fec|rtp',
'StreamId' => '<string>',
'WhitelistCidr' => '<string>',
],
]);
Parameter Details
Members
- AvailabilityZone
-
- Type: string
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region. - Entitlements
-
- Type: Array of GrantEntitlementRequest structures
The entitlements that you want to grant on a flow. - Name
-
- Required: Yes
- Type: string
The name of the flow. - Outputs
-
- Type: Array of AddOutputRequest structures
The outputs that you want to add to this flow. - Source
-
- Required: Yes
- Type: SetSourceRequest structure
The settings for the source of the flow.
Result Syntax
[
'Flow' => [
'AvailabilityZone' => '<string>',
'Description' => '<string>',
'EgressIp' => '<string>',
'Entitlements' => [
[
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'Name' => '<string>',
'Subscribers' => ['<string>', ...],
],
// ...
],
'FlowArn' => '<string>',
'Name' => '<string>',
'Outputs' => [
[
'Description' => '<string>',
'Destination' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'MediaLiveInputArn' => '<string>',
'Name' => '<string>',
'OutputArn' => '<string>',
'Port' => <integer>,
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
],
// ...
],
'Source' => [
'Decryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'Description' => '<string>',
'EntitlementArn' => '<string>',
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'Name' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
'WhitelistCidr' => '<string>',
],
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
],
]
Result Details
Members
- Flow
-
- Type: Flow structure
The settings for a flow, including its source, outputs, and entitlements.
Errors
-
CreateFlow420Exception: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
DeleteFlow
$result = $client->deleteFlow([/* ... */]); $promise = $client->deleteFlowAsync([/* ... */]);
Parameter Syntax
$result = $client->deleteFlow([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'FlowArn' => '<string>',
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
DescribeFlow
$result = $client->describeFlow([/* ... */]); $promise = $client->describeFlowAsync([/* ... */]);
Parameter Syntax
$result = $client->describeFlow([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Flow' => [
'AvailabilityZone' => '<string>',
'Description' => '<string>',
'EgressIp' => '<string>',
'Entitlements' => [
[
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'Name' => '<string>',
'Subscribers' => ['<string>', ...],
],
// ...
],
'FlowArn' => '<string>',
'Name' => '<string>',
'Outputs' => [
[
'Description' => '<string>',
'Destination' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'MediaLiveInputArn' => '<string>',
'Name' => '<string>',
'OutputArn' => '<string>',
'Port' => <integer>,
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
],
// ...
],
'Source' => [
'Decryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'Description' => '<string>',
'EntitlementArn' => '<string>',
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'Name' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
'WhitelistCidr' => '<string>',
],
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
],
'Messages' => [
'Errors' => ['<string>', ...],
],
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
GrantFlowEntitlements
$result = $client->grantFlowEntitlements([/* ... */]); $promise = $client->grantFlowEntitlementsAsync([/* ... */]);
Parameter Syntax
$result = $client->grantFlowEntitlements([
'Entitlements' => [ // REQUIRED
[
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256', // REQUIRED
'KeyType' => 'static-key',
'RoleArn' => '<string>', // REQUIRED
'SecretArn' => '<string>', // REQUIRED
],
'Name' => '<string>',
'Subscribers' => ['<string>', ...], // REQUIRED
],
// ...
],
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Entitlements
-
- Required: Yes
- Type: Array of GrantEntitlementRequest structures
The list of entitlements that you want to grant. - FlowArn
-
- Required: Yes
- Type: string
Result Syntax
[
'Entitlements' => [
[
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'Name' => '<string>',
'Subscribers' => ['<string>', ...],
],
// ...
],
'FlowArn' => '<string>',
]
Result Details
Members
- Entitlements
-
- Type: Array of Entitlement structures
The entitlements that were just granted. - FlowArn
-
- Type: string
The ARN of the flow that these entitlements were granted to.
Errors
-
GrantFlowEntitlements420Exception: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ListEntitlements
$result = $client->listEntitlements([/* ... */]); $promise = $client->listEntitlementsAsync([/* ... */]);
Parameter Syntax
$result = $client->listEntitlements([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Entitlements' => [
[
'EntitlementArn' => '<string>',
'EntitlementName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Entitlements
-
- Type: Array of ListedEntitlement structures
A list of entitlements that have been granted to you from other AWS accounts. - NextToken
-
- Type: string
The token that identifies which 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.
Errors
-
ServiceUnavailableException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ListFlows
$result = $client->listFlows([/* ... */]); $promise = $client->listFlowsAsync([/* ... */]);
Parameter Syntax
$result = $client->listFlows([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Flows' => [
[
'AvailabilityZone' => '<string>',
'Description' => '<string>',
'FlowArn' => '<string>',
'Name' => '<string>',
'SourceType' => 'OWNED|ENTITLED',
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Flows
-
- Type: Array of ListedFlow structures
A list of flow summaries. - NextToken
-
- Type: string
The token that identifies which batch of results that you want to see. For example, you submit a ListFlows 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 ListFlows request a second time and specify the NextToken value.
Errors
-
ServiceUnavailableException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
NotFoundException: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
RemoveFlowOutput
$result = $client->removeFlowOutput([/* ... */]); $promise = $client->removeFlowOutputAsync([/* ... */]);
Parameter Syntax
$result = $client->removeFlowOutput([
'FlowArn' => '<string>', // REQUIRED
'OutputArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'FlowArn' => '<string>',
'OutputArn' => '<string>',
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
RevokeFlowEntitlement
$result = $client->revokeFlowEntitlement([/* ... */]); $promise = $client->revokeFlowEntitlementAsync([/* ... */]);
Parameter Syntax
$result = $client->revokeFlowEntitlement([
'EntitlementArn' => '<string>', // REQUIRED
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'EntitlementArn' => '<string>',
'FlowArn' => '<string>',
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
StartFlow
$result = $client->startFlow([/* ... */]); $promise = $client->startFlowAsync([/* ... */]);
Parameter Syntax
$result = $client->startFlow([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'FlowArn' => '<string>',
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
StopFlow
$result = $client->stopFlow([/* ... */]); $promise = $client->stopFlowAsync([/* ... */]);
Parameter Syntax
$result = $client->stopFlow([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'FlowArn' => '<string>',
'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]
Result Details
Members
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
NotFoundException: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
NotFoundException: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
-
BadRequestException: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
UpdateFlowEntitlement
$result = $client->updateFlowEntitlement([/* ... */]); $promise = $client->updateFlowEntitlementAsync([/* ... */]);
Parameter Syntax
$result = $client->updateFlowEntitlement([
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>', // REQUIRED
'FlowArn' => '<string>', // REQUIRED
'Subscribers' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Type: string
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
-
- Type: UpdateEncryption structure
The type of encryption that will be used on the output associated with this entitlement. - EntitlementArn
-
- Required: Yes
- Type: string
- FlowArn
-
- Required: Yes
- Type: string
- Subscribers
-
- Type: Array of strings
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.
Result Syntax
[
'Entitlement' => [
'Description' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'Name' => '<string>',
'Subscribers' => ['<string>', ...],
],
'FlowArn' => '<string>',
]
Result Details
Members
- Entitlement
-
- Type: Entitlement structure
The settings for a flow entitlement. - FlowArn
-
- Type: string
The ARN of the flow that this entitlement was granted on.
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
UpdateFlowOutput
$result = $client->updateFlowOutput([/* ... */]); $promise = $client->updateFlowOutputAsync([/* ... */]);
Parameter Syntax
$result = $client->updateFlowOutput([
'Description' => '<string>',
'Destination' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'FlowArn' => '<string>', // REQUIRED
'MaxLatency' => <integer>,
'OutputArn' => '<string>', // REQUIRED
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. - Destination
-
- Type: string
The IP address where you want to send the output. - Encryption
-
- Type: UpdateEncryption structure
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). - FlowArn
-
- Required: Yes
- Type: string
- MaxLatency
-
- Type: int
The maximum latency in milliseconds for Zixi-based streams. - OutputArn
-
- Required: Yes
- Type: string
- Port
-
- Type: int
The port to use when content is distributed to this output. - Protocol
-
- Type: string
The protocol to use for the output. - SmoothingLatency
-
- Type: int
The smoothing latency in milliseconds for RTP and RTP-FEC streams. - StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
Result Syntax
[
'FlowArn' => '<string>',
'Output' => [
'Description' => '<string>',
'Destination' => '<string>',
'Encryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'EntitlementArn' => '<string>',
'MediaLiveInputArn' => '<string>',
'Name' => '<string>',
'OutputArn' => '<string>',
'Port' => <integer>,
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
],
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that is associated with the updated output. - Output
-
- Type: Output structure
The settings for an output.
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
UpdateFlowSource
$result = $client->updateFlowSource([/* ... */]); $promise = $client->updateFlowSourceAsync([/* ... */]);
Parameter Syntax
$result = $client->updateFlowSource([
'Decryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'Description' => '<string>',
'EntitlementArn' => '<string>',
'FlowArn' => '<string>', // REQUIRED
'IngestPort' => <integer>,
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SourceArn' => '<string>', // REQUIRED
'StreamId' => '<string>',
'WhitelistCidr' => '<string>',
]);
Parameter Details
Members
- Decryption
-
- Type: UpdateEncryption structure
The type of encryption used on the content ingested from this source. - Description
-
- Type: string
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. - EntitlementArn
-
- Type: string
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow. - FlowArn
-
- Required: Yes
- Type: string
- IngestPort
-
- Type: int
The port that the flow will be listening on for incoming content. - MaxBitrate
-
- Type: int
The smoothing max bitrate for RTP and RTP-FEC streams. - MaxLatency
-
- Type: int
The maximum latency in milliseconds for Zixi-based streams. - Protocol
-
- Type: string
The protocol that is used by the source. - SourceArn
-
- Required: Yes
- Type: string
- StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. - WhitelistCidr
-
- Type: string
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Result Syntax
[
'FlowArn' => '<string>',
'Source' => [
'Decryption' => [
'Algorithm' => 'aes128|aes192|aes256',
'KeyType' => 'static-key',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
],
'Description' => '<string>',
'EntitlementArn' => '<string>',
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'Name' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp',
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
],
'WhitelistCidr' => '<string>',
],
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that you want to update. - Source
-
- Type: Source structure
The settings for the source of the flow.
Errors
-
BadRequestException: 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: 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: 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: 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: 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: Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.
Shapes
AddFlowOutputs420Exception
Description
Members
AddOutputRequest
Description
Members
- Description
-
- Type: string
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. - Destination
-
- Required: Yes
- Type: string
The IP address from which video will be sent to output destinations. - Encryption
-
- Type: Encryption structure
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). - MaxLatency
-
- Type: int
The maximum latency in milliseconds for Zixi-based streams. - Name
-
- Type: string
The name of the output. This value must be unique within the current flow. - Port
-
- Required: Yes
- Type: int
The port to use when content is distributed to this output. - Protocol
-
- Required: Yes
- Type: string
The protocol to use for the output. - SmoothingLatency
-
- Type: int
The smoothing latency in milliseconds for RTP and RTP-FEC streams. - StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
BadRequestException
Description
Members
CreateFlow420Exception
Description
Members
Encryption
Description
Members
- Algorithm
-
- Required: Yes
- Type: string
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). - KeyType
-
- Type: string
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). - RoleArn
-
- Required: Yes
- Type: string
The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). - SecretArn
-
- Required: Yes
- Type: string
The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
Entitlement
Description
Members
- Description
-
- Type: string
A description of the entitlement. - Encryption
-
- Type: Encryption structure
The type of encryption that will be used on the output that is associated with this entitlement. - EntitlementArn
-
- Required: Yes
- Type: string
The ARN of the entitlement. - Name
-
- Required: Yes
- Type: string
The name of the entitlement. - Subscribers
-
- Required: Yes
- Type: Array of strings
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.
Flow
Description
Members
- AvailabilityZone
-
- Required: Yes
- Type: string
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS. - Description
-
- Type: string
A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account. - EgressIp
-
- Type: string
The IP address from which video will be sent to output destinations. - Entitlements
-
- Required: Yes
- Type: Array of Entitlement structures
The entitlements in this flow. - FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. - Name
-
- Required: Yes
- Type: string
The name of the flow. - Outputs
-
- Required: Yes
- Type: Array of Output structures
The outputs in this flow. - Source
-
- Required: Yes
- Type: Source structure
The settings for the source of the flow. - Status
-
- Required: Yes
- Type: string
The current status of the flow.
ForbiddenException
Description
Members
GrantEntitlementRequest
Description
Members
- Description
-
- Type: string
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
-
- Type: Encryption structure
The type of encryption that will be used on the output that is associated with this entitlement. - Name
-
- Type: string
The name of the entitlement. This value must be unique within the current flow. - Subscribers
-
- Required: Yes
- Type: Array of strings
The AWS 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.
GrantFlowEntitlements420Exception
Description
Members
InternalServerErrorException
Description
Members
ListedEntitlement
Description
Members
ListedFlow
Description
Members
- AvailabilityZone
-
- Required: Yes
- Type: string
The Availability Zone that the flow was created in. - Description
-
- Required: Yes
- Type: string
A description of the flow. - FlowArn
-
- Required: Yes
- Type: string
The ARN of the flow. - Name
-
- Required: Yes
- Type: string
The name of the flow. - SourceType
-
- Required: Yes
- Type: string
The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account). - Status
-
- Required: Yes
- Type: string
The current status of the flow.
Messages
Description
Members
NotFoundException
Description
Members
Output
Description
Members
- Description
-
- Type: string
A description of the output. - Destination
-
- Type: string
The address where you want to send the output. - Encryption
-
- Type: Encryption structure
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). - EntitlementArn
-
- Type: string
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows. - MediaLiveInputArn
-
- Type: string
The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input. - Name
-
- Required: Yes
- Type: string
The name of the output. This value must be unique within the current flow. - OutputArn
-
- Required: Yes
- Type: string
The ARN of the output. - Port
-
- Type: int
The port to use when content is distributed to this output. - Transport
-
- Type: Transport structure
Attributes related to the transport stream that are used in the output.
ResponseError
Description
Members
ServiceUnavailableException
Description
Members
SetSourceRequest
Description
Members
- Decryption
-
- Type: Encryption structure
The type of encryption that is used on the content ingested from this source. - Description
-
- Type: string
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. - EntitlementArn
-
- Type: string
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow. - IngestPort
-
- Type: int
The port that the flow will be listening on for incoming content. - MaxBitrate
-
- Type: int
The smoothing max bitrate for RTP and RTP-FEC streams. - MaxLatency
-
- Type: int
The maximum latency in milliseconds for Zixi-based streams. - Name
-
- Type: string
The name of the source. - Protocol
-
- Type: string
The protocol that is used by the source. - StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. - WhitelistCidr
-
- Type: string
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Source
Description
Members
- Decryption
-
- Type: Encryption structure
The type of encryption that is used on the content ingested from this source. - Description
-
- Type: string
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. - EntitlementArn
-
- Type: string
The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. - IngestIp
-
- Type: string
The IP address that the flow will be listening on for incoming content. - IngestPort
-
- Type: int
The port that the flow will be listening on for incoming content. - Name
-
- Required: Yes
- Type: string
The name of the source. - SourceArn
-
- Required: Yes
- Type: string
The ARN of the source. - Transport
-
- Type: Transport structure
Attributes related to the transport stream that are used in the source. - WhitelistCidr
-
- Type: string
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
TooManyRequestsException
Description
Members
Transport
Description
Members
- MaxBitrate
-
- Type: int
The smoothing max bitrate for RTP and RTP-FEC streams. - MaxLatency
-
- Type: int
The maximum latency in milliseconds for Zixi-based streams. - Protocol
-
- Required: Yes
- Type: string
The protocol that is used by the source or output. - SmoothingLatency
-
- Type: int
The smoothing latency in milliseconds for RTP and RTP-FEC streams. - StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
UpdateEncryption
Description
Members
- Algorithm
-
- Type: string
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). - KeyType
-
- Type: string
The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). - RoleArn
-
- Type: string
The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). - SecretArn
-
- Type: string
The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
