AWS SDK for PHP 3.x

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 */).

AddFlowMediaStreams ( array $params = [] )
Adds media streams to an existing flow.
AddFlowOutputs ( array $params = [] )
Adds outputs to an existing flow.
AddFlowSources ( array $params = [] )
Adds Sources to flow
AddFlowVpcInterfaces ( array $params = [] )
Adds VPC interfaces to flow
CreateFlow ( array $params = [] )
Creates a new flow.
DeleteFlow ( array $params = [] )
Deletes a flow.
DescribeFlow ( array $params = [] )
Displays the details of a flow.
DescribeOffering ( array $params = [] )
Displays the details of an offering.
DescribeReservation ( array $params = [] )
Displays the details of a reservation.
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.
ListOfferings ( array $params = [] )
Displays a list of all offerings that are available to this account in the current AWS Region.
ListReservations ( array $params = [] )
Displays a list of all reservations that have been purchased by this account in the current AWS Region.
ListTagsForResource ( array $params = [] )
List all tags on an AWS Elemental MediaConnect resource
PurchaseOffering ( array $params = [] )
Submits a request to purchase an offering.
RemoveFlowMediaStream ( array $params = [] )
Removes a media stream from a flow.
RemoveFlowOutput ( array $params = [] )
Removes an output from an existing flow.
RemoveFlowSource ( array $params = [] )
Removes a source from an existing flow.
RemoveFlowVpcInterface ( array $params = [] )
Removes a VPC Interface 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.
UpdateFlow ( array $params = [] )
Updates flow
UpdateFlowEntitlement ( array $params = [] )
You can change an entitlement's description, subscribers, and encryption.
UpdateFlowMediaStream ( array $params = [] )
Updates an existing media stream.
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:

ListEntitlements
ListFlows
ListOfferings
ListReservations

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
FlowActive	DescribeFlow	3	40
FlowStandby	DescribeFlow	3	40
FlowDeleted	DescribeFlow	3	40

Operations

AddFlowMediaStreams

$result = $client->addFlowMediaStreams([/* ... */]);
$promise = $client->addFlowMediaStreamsAsync([/* ... */]);

Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.

Parameter Syntax

$result = $client->addFlowMediaStreams([
    'FlowArn' => '<string>', // REQUIRED
    'MediaStreams' => [ // REQUIRED
        [
            'Attributes' => [
                'Fmtp' => [
                    'ChannelOrder' => '<string>',
                    'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                    'ExactFramerate' => '<string>',
                    'Par' => '<string>',
                    'Range' => 'NARROW|FULL|FULLPROTECT',
                    'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                    'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                ],
                'Lang' => '<string>',
            ],
            'ClockRate' => <integer>,
            'Description' => '<string>',
            'MediaStreamId' => <integer>, // REQUIRED
            'MediaStreamName' => '<string>', // REQUIRED
            'MediaStreamType' => 'video|audio|ancillary-data', // REQUIRED
            'VideoFormat' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

MediaStreams

Required: Yes
Type: Array of AddMediaStreamRequest structures

The media streams that you want to add to the flow.

Result Syntax

[
    'FlowArn' => '<string>',
    'MediaStreams' => [
        [
            'Attributes' => [
                'Fmtp' => [
                    'ChannelOrder' => '<string>',
                    'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                    'ExactFramerate' => '<string>',
                    'Par' => '<string>',
                    'Range' => 'NARROW|FULL|FULLPROTECT',
                    'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                    'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                ],
                'Lang' => '<string>',
            ],
            'ClockRate' => <integer>,
            'Description' => '<string>',
            'Fmt' => <integer>,
            'MediaStreamId' => <integer>,
            'MediaStreamName' => '<string>',
            'MediaStreamType' => 'video|audio|ancillary-data',
            'VideoFormat' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that you added media streams to.

MediaStreams

Type: Array of MediaStream structures

The media streams that you added to 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.

AddFlowOutputs

$result = $client->addFlowOutputs([/* ... */]);
$promise = $client->addFlowOutputsAsync([/* ... */]);

Adds outputs to an existing flow. You can create up to 50 outputs per flow.

Parameter Syntax

$result = $client->addFlowOutputs([
    'FlowArn' => '<string>', // REQUIRED
    'Outputs' => [ // REQUIRED
        [
            'CidrAllowList' => ['<string>', ...],
            'Description' => '<string>',
            'Destination' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'MaxLatency' => <integer>,
            'MediaStreamOutputConfigurations' => [
                [
                    'DestinationConfigurations' => [
                        [
                            'DestinationIp' => '<string>', // REQUIRED
                            'DestinationPort' => <integer>, // REQUIRED
                            'Interface' => [ // REQUIRED
                                'Name' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
                    'EncodingParameters' => [
                        'CompressionFactor' => <float>, // REQUIRED
                        'EncoderProfile' => 'main|high', // REQUIRED
                    ],
                    'MediaStreamName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MinLatency' => <integer>,
            'Name' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener', // REQUIRED
            'RemoteId' => '<string>',
            'SmoothingLatency' => <integer>,
            'StreamId' => '<string>',
            'VpcInterfaceAttachment' => [
                'VpcInterfaceName' => '<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' => [
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Description' => '<string>',
            'Destination' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'EntitlementArn' => '<string>',
            'ListenerAddress' => '<string>',
            'MediaLiveInputArn' => '<string>',
            'MediaStreamOutputConfigurations' => [
                [
                    'DestinationConfigurations' => [
                        [
                            'DestinationIp' => '<string>',
                            'DestinationPort' => <integer>,
                            'Interface' => [
                                'Name' => '<string>',
                            ],
                            'OutboundIp' => '<string>',
                        ],
                        // ...
                    ],
                    'EncodingName' => 'jxsv|raw|smpte291|pcm',
                    'EncodingParameters' => [
                        'CompressionFactor' => <float>,
                        'EncoderProfile' => 'main|high',
                    ],
                    'MediaStreamName' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'OutputArn' => '<string>',
            'Port' => <integer>,
            'Transport' => [
                'CidrAllowList' => ['<string>', ...],
                'MaxBitrate' => <integer>,
                'MaxLatency' => <integer>,
                'MaxSyncBuffer' => <integer>,
                'MinLatency' => <integer>,
                'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                'RemoteId' => '<string>',
                'SmoothingLatency' => <integer>,
                'StreamId' => '<string>',
            ],
            'VpcInterfaceAttachment' => [
                'VpcInterfaceName' => '<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.

AddFlowSources

$result = $client->addFlowSources([/* ... */]);
$promise = $client->addFlowSourcesAsync([/* ... */]);

Adds Sources to flow

Parameter Syntax

$result = $client->addFlowSources([
    'FlowArn' => '<string>', // REQUIRED
    'Sources' => [ // REQUIRED
        [
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestPort' => <integer>,
            'MaxBitrate' => <integer>,
            'MaxLatency' => <integer>,
            'MaxSyncBuffer' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
                    'InputConfigurations' => [
                        [
                            'InputPort' => <integer>, // REQUIRED
                            'Interface' => [ // REQUIRED
                                'Name' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MinLatency' => <integer>,
            'Name' => '<string>',
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
            'StreamId' => '<string>',
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

Sources

Required: Yes
Type: Array of SetSourceRequest structures

A list of sources that you want to add.

Result Syntax

[
    'FlowArn' => '<string>',
    'Sources' => [
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestIp' => '<string>',
            'IngestPort' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm',
                    'InputConfigurations' => [
                        [
                            'InputIp' => '<string>',
                            'InputPort' => <integer>,
                            'Interface' => [
                                'Name' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'SourceArn' => '<string>',
            'Transport' => [
                'CidrAllowList' => ['<string>', ...],
                'MaxBitrate' => <integer>,
                'MaxLatency' => <integer>,
                'MaxSyncBuffer' => <integer>,
                'MinLatency' => <integer>,
                'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                'RemoteId' => '<string>',
                'SmoothingLatency' => <integer>,
                'StreamId' => '<string>',
            ],
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that these sources were added to.

Sources

Type: Array of Source structures

The details of the newly added sources.

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.

AddFlowVpcInterfaces

$result = $client->addFlowVpcInterfaces([/* ... */]);
$promise = $client->addFlowVpcInterfacesAsync([/* ... */]);

Adds VPC interfaces to flow

Parameter Syntax

$result = $client->addFlowVpcInterfaces([
    'FlowArn' => '<string>', // REQUIRED
    'VpcInterfaces' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'NetworkInterfaceType' => 'ena|efa',
            'RoleArn' => '<string>', // REQUIRED
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

VpcInterfaces

Required: Yes
Type: Array of VpcInterfaceRequest structures

A list of VPC interfaces that you want to add.

Result Syntax

[
    'FlowArn' => '<string>',
    'VpcInterfaces' => [
        [
            'Name' => '<string>',
            'NetworkInterfaceIds' => ['<string>', ...],
            'NetworkInterfaceType' => 'ena|efa',
            'RoleArn' => '<string>',
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that these VPC interfaces were added to.

VpcInterfaces

Type: Array of VpcInterface structures

The details of the newly added VPC interfaces.

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.

CreateFlow

$result = $client->createFlow([/* ... */]);
$promise = $client->createFlowAsync([/* ... */]);

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

Parameter Syntax

$result = $client->createFlow([
    'AvailabilityZone' => '<string>',
    'Entitlements' => [
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Description' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'EntitlementStatus' => 'ENABLED|DISABLED',
            'Name' => '<string>',
            'Subscribers' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MediaStreams' => [
        [
            'Attributes' => [
                'Fmtp' => [
                    'ChannelOrder' => '<string>',
                    'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                    'ExactFramerate' => '<string>',
                    'Par' => '<string>',
                    'Range' => 'NARROW|FULL|FULLPROTECT',
                    'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                    'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                ],
                'Lang' => '<string>',
            ],
            'ClockRate' => <integer>,
            'Description' => '<string>',
            'MediaStreamId' => <integer>, // REQUIRED
            'MediaStreamName' => '<string>', // REQUIRED
            'MediaStreamType' => 'video|audio|ancillary-data', // REQUIRED
            'VideoFormat' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Outputs' => [
        [
            'CidrAllowList' => ['<string>', ...],
            'Description' => '<string>',
            'Destination' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'MaxLatency' => <integer>,
            'MediaStreamOutputConfigurations' => [
                [
                    'DestinationConfigurations' => [
                        [
                            'DestinationIp' => '<string>', // REQUIRED
                            'DestinationPort' => <integer>, // REQUIRED
                            'Interface' => [ // REQUIRED
                                'Name' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
                    'EncodingParameters' => [
                        'CompressionFactor' => <float>, // REQUIRED
                        'EncoderProfile' => 'main|high', // REQUIRED
                    ],
                    'MediaStreamName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MinLatency' => <integer>,
            'Name' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener', // REQUIRED
            'RemoteId' => '<string>',
            'SmoothingLatency' => <integer>,
            'StreamId' => '<string>',
            'VpcInterfaceAttachment' => [
                'VpcInterfaceName' => '<string>',
            ],
        ],
        // ...
    ],
    'Source' => [
        'Decryption' => [
            'Algorithm' => 'aes128|aes192|aes256',
            'ConstantInitializationVector' => '<string>',
            'DeviceId' => '<string>',
            'KeyType' => 'speke|static-key|srt-password',
            'Region' => '<string>',
            'ResourceId' => '<string>',
            'RoleArn' => '<string>', // REQUIRED
            'SecretArn' => '<string>',
            'Url' => '<string>',
        ],
        'Description' => '<string>',
        'EntitlementArn' => '<string>',
        'IngestPort' => <integer>,
        'MaxBitrate' => <integer>,
        'MaxLatency' => <integer>,
        'MaxSyncBuffer' => <integer>,
        'MediaStreamSourceConfigurations' => [
            [
                'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
                'InputConfigurations' => [
                    [
                        'InputPort' => <integer>, // REQUIRED
                        'Interface' => [ // REQUIRED
                            'Name' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'MediaStreamName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'MinLatency' => <integer>,
        'Name' => '<string>',
        'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
        'StreamId' => '<string>',
        'VpcInterfaceName' => '<string>',
        'WhitelistCidr' => '<string>',
    ],
    'SourceFailoverConfig' => [
        'FailoverMode' => 'MERGE|FAILOVER',
        'RecoveryWindow' => <integer>,
        'SourcePriority' => [
            'PrimarySource' => '<string>',
        ],
        'State' => 'ENABLED|DISABLED',
    ],
    'Sources' => [
        [
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestPort' => <integer>,
            'MaxBitrate' => <integer>,
            'MaxLatency' => <integer>,
            'MaxSyncBuffer' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
                    'InputConfigurations' => [
                        [
                            'InputPort' => <integer>, // REQUIRED
                            'Interface' => [ // REQUIRED
                                'Name' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MinLatency' => <integer>,
            'Name' => '<string>',
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
            'StreamId' => '<string>',
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        // ...
    ],
    'VpcInterfaces' => [
        [
            'Name' => '<string>', // REQUIRED
            'NetworkInterfaceType' => 'ena|efa',
            'RoleArn' => '<string>', // REQUIRED
            'SecurityGroupIds' => ['<string>', ...], // REQUIRED
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

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.

MediaStreams

Type: Array of AddMediaStreamRequest structures

The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the 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

Type: SetSourceRequest structure

The settings for the source of the flow.

SourceFailoverConfig

Type: FailoverConfig structure

The settings for source failover

Sources

Type: Array of SetSourceRequest structures

VpcInterfaces

Type: Array of VpcInterfaceRequest structures

The VPC interfaces you want on the flow.

Result Syntax

[
    'Flow' => [
        'AvailabilityZone' => '<string>',
        'Description' => '<string>',
        'EgressIp' => '<string>',
        'Entitlements' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'EntitlementStatus' => 'ENABLED|DISABLED',
                'Name' => '<string>',
                'Subscribers' => ['<string>', ...],
            ],
            // ...
        ],
        'FlowArn' => '<string>',
        'MediaStreams' => [
            [
                'Attributes' => [
                    'Fmtp' => [
                        'ChannelOrder' => '<string>',
                        'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                        'ExactFramerate' => '<string>',
                        'Par' => '<string>',
                        'Range' => 'NARROW|FULL|FULLPROTECT',
                        'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                        'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                    ],
                    'Lang' => '<string>',
                ],
                'ClockRate' => <integer>,
                'Description' => '<string>',
                'Fmt' => <integer>,
                'MediaStreamId' => <integer>,
                'MediaStreamName' => '<string>',
                'MediaStreamType' => 'video|audio|ancillary-data',
                'VideoFormat' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'Outputs' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Destination' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'ListenerAddress' => '<string>',
                'MediaLiveInputArn' => '<string>',
                'MediaStreamOutputConfigurations' => [
                    [
                        'DestinationConfigurations' => [
                            [
                                'DestinationIp' => '<string>',
                                'DestinationPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                                'OutboundIp' => '<string>',
                            ],
                            // ...
                        ],
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'EncodingParameters' => [
                            'CompressionFactor' => <float>,
                            'EncoderProfile' => 'main|high',
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'OutputArn' => '<string>',
                'Port' => <integer>,
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceAttachment' => [
                    'VpcInterfaceName' => '<string>',
                ],
            ],
            // ...
        ],
        'Source' => [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestIp' => '<string>',
            'IngestPort' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm',
                    'InputConfigurations' => [
                        [
                            'InputIp' => '<string>',
                            'InputPort' => <integer>,
                            'Interface' => [
                                'Name' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'SourceArn' => '<string>',
            'Transport' => [
                'CidrAllowList' => ['<string>', ...],
                'MaxBitrate' => <integer>,
                'MaxLatency' => <integer>,
                'MaxSyncBuffer' => <integer>,
                'MinLatency' => <integer>,
                'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                'RemoteId' => '<string>',
                'SmoothingLatency' => <integer>,
                'StreamId' => '<string>',
            ],
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        'SourceFailoverConfig' => [
            'FailoverMode' => 'MERGE|FAILOVER',
            'RecoveryWindow' => <integer>,
            'SourcePriority' => [
                'PrimarySource' => '<string>',
            ],
            'State' => 'ENABLED|DISABLED',
        ],
        'Sources' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Decryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'Description' => '<string>',
                'EntitlementArn' => '<string>',
                'IngestIp' => '<string>',
                'IngestPort' => <integer>,
                'MediaStreamSourceConfigurations' => [
                    [
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'InputConfigurations' => [
                            [
                                'InputIp' => '<string>',
                                'InputPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'SourceArn' => '<string>',
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceName' => '<string>',
                'WhitelistCidr' => '<string>',
            ],
            // ...
        ],
        'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
        'VpcInterfaces' => [
            [
                'Name' => '<string>',
                'NetworkInterfaceIds' => ['<string>', ...],
                'NetworkInterfaceType' => 'ena|efa',
                'RoleArn' => '<string>',
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetId' => '<string>',
            ],
            // ...
        ],
    ],
]

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([/* ... */]);

Deletes a flow. Before you can delete a flow, you must stop the flow.

Parameter Syntax

$result = $client->deleteFlow([
    'FlowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that was deleted.

Status

Type: string

The status of the flow when the DeleteFlow process begins.

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([/* ... */]);

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.

Parameter Syntax

$result = $client->describeFlow([
    'FlowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

Result Syntax

[
    'Flow' => [
        'AvailabilityZone' => '<string>',
        'Description' => '<string>',
        'EgressIp' => '<string>',
        'Entitlements' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'EntitlementStatus' => 'ENABLED|DISABLED',
                'Name' => '<string>',
                'Subscribers' => ['<string>', ...],
            ],
            // ...
        ],
        'FlowArn' => '<string>',
        'MediaStreams' => [
            [
                'Attributes' => [
                    'Fmtp' => [
                        'ChannelOrder' => '<string>',
                        'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                        'ExactFramerate' => '<string>',
                        'Par' => '<string>',
                        'Range' => 'NARROW|FULL|FULLPROTECT',
                        'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                        'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                    ],
                    'Lang' => '<string>',
                ],
                'ClockRate' => <integer>,
                'Description' => '<string>',
                'Fmt' => <integer>,
                'MediaStreamId' => <integer>,
                'MediaStreamName' => '<string>',
                'MediaStreamType' => 'video|audio|ancillary-data',
                'VideoFormat' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'Outputs' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Destination' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'ListenerAddress' => '<string>',
                'MediaLiveInputArn' => '<string>',
                'MediaStreamOutputConfigurations' => [
                    [
                        'DestinationConfigurations' => [
                            [
                                'DestinationIp' => '<string>',
                                'DestinationPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                                'OutboundIp' => '<string>',
                            ],
                            // ...
                        ],
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'EncodingParameters' => [
                            'CompressionFactor' => <float>,
                            'EncoderProfile' => 'main|high',
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'OutputArn' => '<string>',
                'Port' => <integer>,
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceAttachment' => [
                    'VpcInterfaceName' => '<string>',
                ],
            ],
            // ...
        ],
        'Source' => [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestIp' => '<string>',
            'IngestPort' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm',
                    'InputConfigurations' => [
                        [
                            'InputIp' => '<string>',
                            'InputPort' => <integer>,
                            'Interface' => [
                                'Name' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'SourceArn' => '<string>',
            'Transport' => [
                'CidrAllowList' => ['<string>', ...],
                'MaxBitrate' => <integer>,
                'MaxLatency' => <integer>,
                'MaxSyncBuffer' => <integer>,
                'MinLatency' => <integer>,
                'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                'RemoteId' => '<string>',
                'SmoothingLatency' => <integer>,
                'StreamId' => '<string>',
            ],
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        'SourceFailoverConfig' => [
            'FailoverMode' => 'MERGE|FAILOVER',
            'RecoveryWindow' => <integer>,
            'SourcePriority' => [
                'PrimarySource' => '<string>',
            ],
            'State' => 'ENABLED|DISABLED',
        ],
        'Sources' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Decryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'Description' => '<string>',
                'EntitlementArn' => '<string>',
                'IngestIp' => '<string>',
                'IngestPort' => <integer>,
                'MediaStreamSourceConfigurations' => [
                    [
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'InputConfigurations' => [
                            [
                                'InputIp' => '<string>',
                                'InputPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'SourceArn' => '<string>',
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceName' => '<string>',
                'WhitelistCidr' => '<string>',
            ],
            // ...
        ],
        'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
        'VpcInterfaces' => [
            [
                'Name' => '<string>',
                'NetworkInterfaceIds' => ['<string>', ...],
                'NetworkInterfaceType' => 'ena|efa',
                'RoleArn' => '<string>',
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetId' => '<string>',
            ],
            // ...
        ],
    ],
    'Messages' => [
        'Errors' => ['<string>', ...],
    ],
]

Result Details

Members

Flow

Type: Flow structure

The settings for a flow, including its source, outputs, and entitlements.

Messages

Type: Messages structure

Messages that provide the state 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.

DescribeOffering

$result = $client->describeOffering([/* ... */]);
$promise = $client->describeOfferingAsync([/* ... */]);

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->describeOffering([
    'OfferingArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

OfferingArn

Required: Yes
Type: string

Result Syntax

[
    'Offering' => [
        'CurrencyCode' => '<string>',
        'Duration' => <integer>,
        'DurationUnits' => 'MONTHS',
        'OfferingArn' => '<string>',
        'OfferingDescription' => '<string>',
        'PricePerUnit' => '<string>',
        'PriceUnits' => 'HOURLY',
        'ResourceSpecification' => [
            'ReservedBitrate' => <integer>,
            'ResourceType' => 'Mbps_Outbound_Bandwidth',
        ],
    ],
]

Result Details

Members

Offering

Type: Offering structure

A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.

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.
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.

DescribeReservation

$result = $client->describeReservation([/* ... */]);
$promise = $client->describeReservationAsync([/* ... */]);

Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).

Parameter Syntax

$result = $client->describeReservation([
    'ReservationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ReservationArn

Required: Yes
Type: string

Result Syntax

[
    'Reservation' => [
        'CurrencyCode' => '<string>',
        'Duration' => <integer>,
        'DurationUnits' => 'MONTHS',
        'End' => '<string>',
        'OfferingArn' => '<string>',
        'OfferingDescription' => '<string>',
        'PricePerUnit' => '<string>',
        'PriceUnits' => 'HOURLY',
        'ReservationArn' => '<string>',
        'ReservationName' => '<string>',
        'ReservationState' => 'ACTIVE|EXPIRED|PROCESSING|CANCELED',
        'ResourceSpecification' => [
            'ReservedBitrate' => <integer>,
            'ResourceType' => 'Mbps_Outbound_Bandwidth',
        ],
        'Start' => '<string>',
    ],
]

Result Details

Members

Reservation

Type: Reservation structure

A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.

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.
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.

GrantFlowEntitlements

$result = $client->grantFlowEntitlements([/* ... */]);
$promise = $client->grantFlowEntitlementsAsync([/* ... */]);

Grants entitlements to an existing flow.

Parameter Syntax

$result = $client->grantFlowEntitlements([
    'Entitlements' => [ // REQUIRED
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Description' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>', // REQUIRED
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'EntitlementStatus' => 'ENABLED|DISABLED',
            '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' => [
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Description' => '<string>',
            'Encryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'EntitlementArn' => '<string>',
            'EntitlementStatus' => 'ENABLED|DISABLED',
            '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([/* ... */]);

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

Parameter Syntax

$result = $client->listEntitlements([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'Entitlements' => [
        [
            'DataTransferSubscriberFeePercent' => <integer>,
            '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([/* ... */]);

Displays a list of flows that are associated with this account. This request returns a paginated result.

Parameter Syntax

$result = $client->listFlows([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

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.

ListOfferings

$result = $client->listOfferings([/* ... */]);
$promise = $client->listOfferingsAsync([/* ... */]);

Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

Parameter Syntax

$result = $client->listOfferings([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Offerings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'DurationUnits' => 'MONTHS',
            'OfferingArn' => '<string>',
            'OfferingDescription' => '<string>',
            'PricePerUnit' => '<string>',
            'PriceUnits' => 'HOURLY',
            'ResourceSpecification' => [
                'ReservedBitrate' => <integer>,
                'ResourceType' => 'Mbps_Outbound_Bandwidth',
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings 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 ListOfferings request a second time and specify the NextToken value.

Offerings

Type: Array of Offering structures

A list of offerings that are available to this account in the current AWS Region.

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.

ListReservations

$result = $client->listReservations([/* ... */]);
$promise = $client->listReservationsAsync([/* ... */]);

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).

Parameter Syntax

$result = $client->listReservations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Reservations' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'DurationUnits' => 'MONTHS',
            'End' => '<string>',
            'OfferingArn' => '<string>',
            'OfferingDescription' => '<string>',
            'PricePerUnit' => '<string>',
            'PriceUnits' => 'HOURLY',
            'ReservationArn' => '<string>',
            'ReservationName' => '<string>',
            'ReservationState' => 'ACTIVE|EXPIRED|PROCESSING|CANCELED',
            'ResourceSpecification' => [
                'ReservedBitrate' => <integer>,
                'ResourceType' => 'Mbps_Outbound_Bandwidth',
            ],
            'Start' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token that identifies which batch of results that you want to see. For example, you submit a ListReservations 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 ListReservations request a second time and specify the NextToken value.

Reservations

Type: Array of Reservation structures

A list of all reservations that have been purchased by this account in the current AWS Region.

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([/* ... */]);

List all tags on an AWS Elemental MediaConnect resource

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (__string) to strings

A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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.

PurchaseOffering

$result = $client->purchaseOffering([/* ... */]);
$promise = $client->purchaseOfferingAsync([/* ... */]);

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

Parameter Syntax

$result = $client->purchaseOffering([
    'OfferingArn' => '<string>', // REQUIRED
    'ReservationName' => '<string>', // REQUIRED
    'Start' => '<string>', // REQUIRED
]);

Parameter Details

Members

OfferingArn

Required: Yes
Type: string

ReservationName

Required: Yes
Type: string

The name that you want to use for the reservation.

Start

Required: Yes
Type: string

The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.

Result Syntax

[
    'Reservation' => [
        'CurrencyCode' => '<string>',
        'Duration' => <integer>,
        'DurationUnits' => 'MONTHS',
        'End' => '<string>',
        'OfferingArn' => '<string>',
        'OfferingDescription' => '<string>',
        'PricePerUnit' => '<string>',
        'PriceUnits' => 'HOURLY',
        'ReservationArn' => '<string>',
        'ReservationName' => '<string>',
        'ReservationState' => 'ACTIVE|EXPIRED|PROCESSING|CANCELED',
        'ResourceSpecification' => [
            'ReservedBitrate' => <integer>,
            'ResourceType' => 'Mbps_Outbound_Bandwidth',
        ],
        'Start' => '<string>',
    ],
]

Result Details

Members

Reservation

Type: Reservation structure

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.

RemoveFlowMediaStream

$result = $client->removeFlowMediaStream([/* ... */]);
$promise = $client->removeFlowMediaStreamAsync([/* ... */]);

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

Parameter Syntax

$result = $client->removeFlowMediaStream([
    'FlowArn' => '<string>', // REQUIRED
    'MediaStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

MediaStreamName

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'MediaStreamName' => '<string>',
]

Result Details

Members

FlowArn

Type: string

The Amazon Resource Name (ARN) of the flow.

MediaStreamName

Type: string

The name of the media stream that was removed.

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.

RemoveFlowOutput

$result = $client->removeFlowOutput([/* ... */]);
$promise = $client->removeFlowOutputAsync([/* ... */]);

Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.

Parameter Syntax

$result = $client->removeFlowOutput([
    'FlowArn' => '<string>', // REQUIRED
    'OutputArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

OutputArn

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'OutputArn' => '<string>',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that is associated with the output you removed.

OutputArn

Type: string

The ARN of the output that was removed.

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.

RemoveFlowSource

$result = $client->removeFlowSource([/* ... */]);
$promise = $client->removeFlowSourceAsync([/* ... */]);

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

Parameter Syntax

$result = $client->removeFlowSource([
    'FlowArn' => '<string>', // REQUIRED
    'SourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

SourceArn

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'SourceArn' => '<string>',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that is associated with the source you removed.

SourceArn

Type: string

The ARN of the source that was removed.

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.

RemoveFlowVpcInterface

$result = $client->removeFlowVpcInterface([/* ... */]);
$promise = $client->removeFlowVpcInterfaceAsync([/* ... */]);

Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.

Parameter Syntax

$result = $client->removeFlowVpcInterface([
    'FlowArn' => '<string>', // REQUIRED
    'VpcInterfaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

VpcInterfaceName

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'NonDeletedNetworkInterfaceIds' => ['<string>', ...],
    'VpcInterfaceName' => '<string>',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that is associated with the VPC interface you removed.

NonDeletedNetworkInterfaceIds

Type: Array of strings

IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.

VpcInterfaceName

Type: string

The name of the VPC interface that was removed.

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([/* ... */]);

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

Parameter Syntax

$result = $client->revokeFlowEntitlement([
    'EntitlementArn' => '<string>', // REQUIRED
    'FlowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EntitlementArn

Required: Yes
Type: string

FlowArn

Required: Yes
Type: string

Result Syntax

[
    'EntitlementArn' => '<string>',
    'FlowArn' => '<string>',
]

Result Details

Members

EntitlementArn

Type: string

The ARN of the entitlement that was revoked.

FlowArn

Type: string

The ARN of the flow that the entitlement was revoked from.

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([/* ... */]);

Starts a flow.

Parameter Syntax

$result = $client->startFlow([
    'FlowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that you started.

Status

Type: string

The status of the flow when the StartFlow process begins.

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([/* ... */]);

Stops a flow.

Parameter Syntax

$result = $client->stopFlow([
    'FlowArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

Result Syntax

[
    'FlowArn' => '<string>',
    'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that you stopped.

Status

Type: string

The status of the flow when the StopFlow process begins.

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([/* ... */]);

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

Tags

Required: Yes
Type: Associative array of custom strings keys (__string) to strings

A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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([/* ... */]);

Deletes specified tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

TagKeys

Required: Yes
Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

UpdateFlow

$result = $client->updateFlow([/* ... */]);
$promise = $client->updateFlowAsync([/* ... */]);

Updates flow

Parameter Syntax

$result = $client->updateFlow([
    'FlowArn' => '<string>', // REQUIRED
    'SourceFailoverConfig' => [
        'FailoverMode' => 'MERGE|FAILOVER',
        'RecoveryWindow' => <integer>,
        'SourcePriority' => [
            'PrimarySource' => '<string>',
        ],
        'State' => 'ENABLED|DISABLED',
    ],
]);

Parameter Details

Members

FlowArn

Required: Yes
Type: string

SourceFailoverConfig

Type: UpdateFailoverConfig structure

The settings for source failover

Result Syntax

[
    'Flow' => [
        'AvailabilityZone' => '<string>',
        'Description' => '<string>',
        'EgressIp' => '<string>',
        'Entitlements' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'EntitlementStatus' => 'ENABLED|DISABLED',
                'Name' => '<string>',
                'Subscribers' => ['<string>', ...],
            ],
            // ...
        ],
        'FlowArn' => '<string>',
        'MediaStreams' => [
            [
                'Attributes' => [
                    'Fmtp' => [
                        'ChannelOrder' => '<string>',
                        'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                        'ExactFramerate' => '<string>',
                        'Par' => '<string>',
                        'Range' => 'NARROW|FULL|FULLPROTECT',
                        'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                        'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
                    ],
                    'Lang' => '<string>',
                ],
                'ClockRate' => <integer>,
                'Description' => '<string>',
                'Fmt' => <integer>,
                'MediaStreamId' => <integer>,
                'MediaStreamName' => '<string>',
                'MediaStreamType' => 'video|audio|ancillary-data',
                'VideoFormat' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'Outputs' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Description' => '<string>',
                'Destination' => '<string>',
                'Encryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'EntitlementArn' => '<string>',
                'ListenerAddress' => '<string>',
                'MediaLiveInputArn' => '<string>',
                'MediaStreamOutputConfigurations' => [
                    [
                        'DestinationConfigurations' => [
                            [
                                'DestinationIp' => '<string>',
                                'DestinationPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                                'OutboundIp' => '<string>',
                            ],
                            // ...
                        ],
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'EncodingParameters' => [
                            'CompressionFactor' => <float>,
                            'EncoderProfile' => 'main|high',
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'OutputArn' => '<string>',
                'Port' => <integer>,
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceAttachment' => [
                    'VpcInterfaceName' => '<string>',
                ],
            ],
            // ...
        ],
        'Source' => [
            'DataTransferSubscriberFeePercent' => <integer>,
            'Decryption' => [
                'Algorithm' => 'aes128|aes192|aes256',
                'ConstantInitializationVector' => '<string>',
                'DeviceId' => '<string>',
                'KeyType' => 'speke|static-key|srt-password',
                'Region' => '<string>',
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'SecretArn' => '<string>',
                'Url' => '<string>',
            ],
            'Description' => '<string>',
            'EntitlementArn' => '<string>',
            'IngestIp' => '<string>',
            'IngestPort' => <integer>,
            'MediaStreamSourceConfigurations' => [
                [
                    'EncodingName' => 'jxsv|raw|smpte291|pcm',
                    'InputConfigurations' => [
                        [
                            'InputIp' => '<string>',
                            'InputPort' => <integer>,
                            'Interface' => [
                                'Name' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'MediaStreamName' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'SourceArn' => '<string>',
            'Transport' => [
                'CidrAllowList' => ['<string>', ...],
                'MaxBitrate' => <integer>,
                'MaxLatency' => <integer>,
                'MaxSyncBuffer' => <integer>,
                'MinLatency' => <integer>,
                'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                'RemoteId' => '<string>',
                'SmoothingLatency' => <integer>,
                'StreamId' => '<string>',
            ],
            'VpcInterfaceName' => '<string>',
            'WhitelistCidr' => '<string>',
        ],
        'SourceFailoverConfig' => [
            'FailoverMode' => 'MERGE|FAILOVER',
            'RecoveryWindow' => <integer>,
            'SourcePriority' => [
                'PrimarySource' => '<string>',
            ],
            'State' => 'ENABLED|DISABLED',
        ],
        'Sources' => [
            [
                'DataTransferSubscriberFeePercent' => <integer>,
                'Decryption' => [
                    'Algorithm' => 'aes128|aes192|aes256',
                    'ConstantInitializationVector' => '<string>',
                    'DeviceId' => '<string>',
                    'KeyType' => 'speke|static-key|srt-password',
                    'Region' => '<string>',
                    'ResourceId' => '<string>',
                    'RoleArn' => '<string>',
                    'SecretArn' => '<string>',
                    'Url' => '<string>',
                ],
                'Description' => '<string>',
                'EntitlementArn' => '<string>',
                'IngestIp' => '<string>',
                'IngestPort' => <integer>,
                'MediaStreamSourceConfigurations' => [
                    [
                        'EncodingName' => 'jxsv|raw|smpte291|pcm',
                        'InputConfigurations' => [
                            [
                                'InputIp' => '<string>',
                                'InputPort' => <integer>,
                                'Interface' => [
                                    'Name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'MediaStreamName' => '<string>',
                    ],
                    // ...
                ],
                'Name' => '<string>',
                'SourceArn' => '<string>',
                'Transport' => [
                    'CidrAllowList' => ['<string>', ...],
                    'MaxBitrate' => <integer>,
                    'MaxLatency' => <integer>,
                    'MaxSyncBuffer' => <integer>,
                    'MinLatency' => <integer>,
                    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
                    'RemoteId' => '<string>',
                    'SmoothingLatency' => <integer>,
                    'StreamId' => '<string>',
                ],
                'VpcInterfaceName' => '<string>',
                'WhitelistCidr' => '<string>',
            ],
            // ...
        ],
        'Status' => 'STANDBY|ACTIVE|UPDATING|DELETING|STARTING|STOPPING|ERROR',
        'VpcInterfaces' => [
            [
                'Name' => '<string>',
                'NetworkInterfaceIds' => ['<string>', ...],
                'NetworkInterfaceType' => 'ena|efa',
                'RoleArn' => '<string>',
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Flow

Type: Flow structure

The settings for a flow, including its source, outputs, and entitlements.

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.

UpdateFlowEntitlement

$result = $client->updateFlowEntitlement([/* ... */]);
$promise = $client->updateFlowEntitlementAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateFlowEntitlement([
    'Description' => '<string>',
    'Encryption' => [
        'Algorithm' => 'aes128|aes192|aes256',
        'ConstantInitializationVector' => '<string>',
        'DeviceId' => '<string>',
        'KeyType' => 'speke|static-key|srt-password',
        'Region' => '<string>',
        'ResourceId' => '<string>',
        'RoleArn' => '<string>',
        'SecretArn' => '<string>',
        'Url' => '<string>',
    ],
    'EntitlementArn' => '<string>', // REQUIRED
    'EntitlementStatus' => 'ENABLED|DISABLED',
    '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

EntitlementStatus

Type: string

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

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' => [
        'DataTransferSubscriberFeePercent' => <integer>,
        'Description' => '<string>',
        'Encryption' => [
            'Algorithm' => 'aes128|aes192|aes256',
            'ConstantInitializationVector' => '<string>',
            'DeviceId' => '<string>',
            'KeyType' => 'speke|static-key|srt-password',
            'Region' => '<string>',
            'ResourceId' => '<string>',
            'RoleArn' => '<string>',
            'SecretArn' => '<string>',
            'Url' => '<string>',
        ],
        'EntitlementArn' => '<string>',
        'EntitlementStatus' => 'ENABLED|DISABLED',
        'Name' => '<string>',
        'Subscribers' => ['<string>', ...],
    ],
    'FlowArn' => '<string>',
]

Result Details

Members

Entitlement

Type: Entitlement structure

The new configuration of the entitlement that you updated.

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.

UpdateFlowMediaStream

$result = $client->updateFlowMediaStream([/* ... */]);
$promise = $client->updateFlowMediaStreamAsync([/* ... */]);

Updates an existing media stream.

Parameter Syntax

$result = $client->updateFlowMediaStream([
    'Attributes' => [
        'Fmtp' => [
            'ChannelOrder' => '<string>',
            'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
            'ExactFramerate' => '<string>',
            'Par' => '<string>',
            'Range' => 'NARROW|FULL|FULLPROTECT',
            'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
            'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
        ],
        'Lang' => '<string>',
    ],
    'ClockRate' => <integer>,
    'Description' => '<string>',
    'FlowArn' => '<string>', // REQUIRED
    'MediaStreamName' => '<string>', // REQUIRED
    'MediaStreamType' => 'video|audio|ancillary-data',
    'VideoFormat' => '<string>',
]);

Parameter Details

Members

Attributes

Type: MediaStreamAttributesRequest structure

The attributes that you want to assign to the media stream.

ClockRate

Type: int

The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.

Description

Type: string

Description

FlowArn

Required: Yes
Type: string

MediaStreamName

Required: Yes
Type: string

MediaStreamType

Type: string

The type of media stream.

VideoFormat

Type: string

The resolution of the video.

Result Syntax

[
    'FlowArn' => '<string>',
    'MediaStream' => [
        'Attributes' => [
            'Fmtp' => [
                'ChannelOrder' => '<string>',
                'Colorimetry' => 'BT601|BT709|BT2020|BT2100|ST2065-1|ST2065-3|XYZ',
                'ExactFramerate' => '<string>',
                'Par' => '<string>',
                'Range' => 'NARROW|FULL|FULLPROTECT',
                'ScanMode' => 'progressive|interlace|progressive-segmented-frame',
                'Tcs' => 'SDR|PQ|HLG|LINEAR|BT2100LINPQ|BT2100LINHLG|ST2065-1|ST428-1|DENSITY',
            ],
            'Lang' => '<string>',
        ],
        'ClockRate' => <integer>,
        'Description' => '<string>',
        'Fmt' => <integer>,
        'MediaStreamId' => <integer>,
        'MediaStreamName' => '<string>',
        'MediaStreamType' => 'video|audio|ancillary-data',
        'VideoFormat' => '<string>',
    ],
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that is associated with the media stream that you updated.

MediaStream

Type: MediaStream structure

The media stream that you updated.

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([/* ... */]);

Updates an existing flow output.

Parameter Syntax

$result = $client->updateFlowOutput([
    'CidrAllowList' => ['<string>', ...],
    'Description' => '<string>',
    'Destination' => '<string>',
    'Encryption' => [
        'Algorithm' => 'aes128|aes192|aes256',
        'ConstantInitializationVector' => '<string>',
        'DeviceId' => '<string>',
        'KeyType' => 'speke|static-key|srt-password',
        'Region' => '<string>',
        'ResourceId' => '<string>',
        'RoleArn' => '<string>',
        'SecretArn' => '<string>',
        'Url' => '<string>',
    ],
    'FlowArn' => '<string>', // REQUIRED
    'MaxLatency' => <integer>,
    'MediaStreamOutputConfigurations' => [
        [
            'DestinationConfigurations' => [
                [
                    'DestinationIp' => '<string>', // REQUIRED
                    'DestinationPort' => <integer>, // REQUIRED
                    'Interface' => [ // REQUIRED
                        'Name' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
            'EncodingParameters' => [
                'CompressionFactor' => <float>, // REQUIRED
                'EncoderProfile' => 'main|high', // REQUIRED
            ],
            'MediaStreamName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MinLatency' => <integer>,
    'OutputArn' => '<string>', // REQUIRED
    'Port' => <integer>,
    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
    'RemoteId' => '<string>',
    'SmoothingLatency' => <integer>,
    'StreamId' => '<string>',
    'VpcInterfaceAttachment' => [
        'VpcInterfaceName' => '<string>',
    ],
]);

Parameter Details

Members

CidrAllowList

Type: Array of strings

The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

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.

MediaStreamOutputConfigurations

Type: Array of MediaStreamOutputConfigurationRequest structures

The media streams that are associated with the output, and the parameters for those associations.

MinLatency

Type: int

The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

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.

RemoteId

Type: string

The remote ID for the Zixi-pull stream.

SmoothingLatency

Type: int

The smoothing latency in milliseconds for RIST, 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.

VpcInterfaceAttachment

Type: VpcInterfaceAttachment structure

The name of the VPC interface attachment to use for this output.

Result Syntax

[
    'FlowArn' => '<string>',
    'Output' => [
        'DataTransferSubscriberFeePercent' => <integer>,
        'Description' => '<string>',
        'Destination' => '<string>',
        'Encryption' => [
            'Algorithm' => 'aes128|aes192|aes256',
            'ConstantInitializationVector' => '<string>',
            'DeviceId' => '<string>',
            'KeyType' => 'speke|static-key|srt-password',
            'Region' => '<string>',
            'ResourceId' => '<string>',
            'RoleArn' => '<string>',
            'SecretArn' => '<string>',
            'Url' => '<string>',
        ],
        'EntitlementArn' => '<string>',
        'ListenerAddress' => '<string>',
        'MediaLiveInputArn' => '<string>',
        'MediaStreamOutputConfigurations' => [
            [
                'DestinationConfigurations' => [
                    [
                        'DestinationIp' => '<string>',
                        'DestinationPort' => <integer>,
                        'Interface' => [
                            'Name' => '<string>',
                        ],
                        'OutboundIp' => '<string>',
                    ],
                    // ...
                ],
                'EncodingName' => 'jxsv|raw|smpte291|pcm',
                'EncodingParameters' => [
                    'CompressionFactor' => <float>,
                    'EncoderProfile' => 'main|high',
                ],
                'MediaStreamName' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'OutputArn' => '<string>',
        'Port' => <integer>,
        'Transport' => [
            'CidrAllowList' => ['<string>', ...],
            'MaxBitrate' => <integer>,
            'MaxLatency' => <integer>,
            'MaxSyncBuffer' => <integer>,
            'MinLatency' => <integer>,
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
            'RemoteId' => '<string>',
            'SmoothingLatency' => <integer>,
            'StreamId' => '<string>',
        ],
        'VpcInterfaceAttachment' => [
            'VpcInterfaceName' => '<string>',
        ],
    ],
]

Result Details

Members

FlowArn

Type: string

The ARN of the flow that is associated with the updated output.

Output

Type: Output structure

The new settings of the output that you updated.

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([/* ... */]);

Updates the source of a flow.

Parameter Syntax

$result = $client->updateFlowSource([
    'Decryption' => [
        'Algorithm' => 'aes128|aes192|aes256',
        'ConstantInitializationVector' => '<string>',
        'DeviceId' => '<string>',
        'KeyType' => 'speke|static-key|srt-password',
        'Region' => '<string>',
        'ResourceId' => '<string>',
        'RoleArn' => '<string>',
        'SecretArn' => '<string>',
        'Url' => '<string>',
    ],
    'Description' => '<string>',
    'EntitlementArn' => '<string>',
    'FlowArn' => '<string>', // REQUIRED
    'IngestPort' => <integer>,
    'MaxBitrate' => <integer>,
    'MaxLatency' => <integer>,
    'MaxSyncBuffer' => <integer>,
    'MediaStreamSourceConfigurations' => [
        [
            'EncodingName' => 'jxsv|raw|smpte291|pcm', // REQUIRED
            'InputConfigurations' => [
                [
                    'InputPort' => <integer>, // REQUIRED
                    'Interface' => [ // REQUIRED
                        'Name' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'MediaStreamName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MinLatency' => <integer>,
    'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
    'SourceArn' => '<string>', // REQUIRED
    'StreamId' => '<string>',
    'VpcInterfaceName' => '<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 RIST, RTP, and RTP-FEC streams.

MaxLatency

Type: int

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

MaxSyncBuffer

Type: int

The size of the buffer (in milliseconds) to use to sync incoming source data.

MediaStreamSourceConfigurations

Type: Array of MediaStreamSourceConfigurationRequest structures

The media streams that are associated with the source, and the parameters for those associations.

MinLatency

Type: int

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.

VpcInterfaceName

Type: string

The name of the VPC interface to use for this source.

WhitelistCidr

Type: string

The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Result Syntax

[
    'FlowArn' => '<string>',
    'Source' => [
        'DataTransferSubscriberFeePercent' => <integer>,
        'Decryption' => [
            'Algorithm' => 'aes128|aes192|aes256',
            'ConstantInitializationVector' => '<string>',
            'DeviceId' => '<string>',
            'KeyType' => 'speke|static-key|srt-password',
            'Region' => '<string>',
            'ResourceId' => '<string>',
            'RoleArn' => '<string>',
            'SecretArn' => '<string>',
            'Url' => '<string>',
        ],
        'Description' => '<string>',
        'EntitlementArn' => '<string>',
        'IngestIp' => '<string>',
        'IngestPort' => <integer>,
        'MediaStreamSourceConfigurations' => [
            [
                'EncodingName' => 'jxsv|raw|smpte291|pcm',
                'InputConfigurations' => [
                    [
                        'InputIp' => '<string>',
                        'InputPort' => <integer>,
                        'Interface' => [
                            'Name' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'MediaStreamName' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'SourceArn' => '<string>',
        'Transport' => [
            'CidrAllowList' => ['<string>', ...],
            'MaxBitrate' => <integer>,
            'MaxLatency' => <integer>,
            'MaxSyncBuffer' => <integer>,
            'MinLatency' => <integer>,
            'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener',
            'RemoteId' => '<string>',
            'SmoothingLatency' => <integer>,
            'StreamId' => '<string>',
        ],
        'VpcInterfaceName' => '<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

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

Members

Message

Required: Yes
Type: string

AddMediaStreamRequest

Description

The media stream that you want to add to the flow.

Members

Attributes

Type: MediaStreamAttributesRequest structure

The attributes that you want to assign to the new media stream.

ClockRate

Type: int

The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.

Description

Type: string

A description that can help you quickly identify what your media stream is used for.

MediaStreamId

Required: Yes
Type: int

A unique identifier for the media stream.

MediaStreamName

Required: Yes
Type: string

A name that helps you distinguish one media stream from another.

MediaStreamType

Required: Yes
Type: string

The type of media stream.

VideoFormat

Type: string

The resolution of the video.

AddOutputRequest

Description

The output that you want to add to this flow.

Members

CidrAllowList

Type: Array of strings

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 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.

MediaStreamOutputConfigurations

Type: Array of MediaStreamOutputConfigurationRequest structures

The media streams that are associated with the output, and the parameters for those associations.

MinLatency

Type: int

Name

Type: string

The name of the output. This value must be unique within the current flow.

Port

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.

RemoteId

Type: string

The remote ID for the Zixi-pull output stream.

SmoothingLatency

Type: int

The smoothing latency in milliseconds for RIST, 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.

VpcInterfaceAttachment

Type: VpcInterfaceAttachment structure

The name of the VPC interface attachment to use for this output.

BadRequestException

Description

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

Members

Message

Required: Yes
Type: string

CreateFlow420Exception

Description

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

Members

Message

Required: Yes
Type: string

DestinationConfiguration

Description

The transport parameters that are associated with an outbound media stream.

Members

DestinationIp

Required: Yes
Type: string

The IP address where contents of the media stream will be sent.

DestinationPort

Required: Yes
Type: int

The port to use when the content of the media stream is distributed to the output.

Interface

Required: Yes
Type: Interface structure

The VPC interface that is used for the media stream associated with the output.

OutboundIp

Required: Yes
Type: string

The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.

DestinationConfigurationRequest

Description

The transport parameters that you want to associate with an outbound media stream.

Members

DestinationIp

Required: Yes
Type: string

The IP address where you want MediaConnect to send contents of the media stream.

DestinationPort

Required: Yes
Type: int

The port that you want MediaConnect to use when it distributes the media stream to the output.

Interface

Required: Yes
Type: InterfaceRequest structure

The VPC interface that you want to use for the media stream associated with the output.

EncodingParameters

Description

A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.

Members

CompressionFactor

Required: Yes
Type: double

A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.

EncoderProfile

Required: Yes
Type: string

A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.

EncodingParametersRequest

Description

A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.

Members

CompressionFactor

Required: Yes
Type: double

EncoderProfile

Required: Yes
Type: string

A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.

Encryption

Description

Information about the encryption of the flow.

Members

Algorithm

Type: string

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

ConstantInitializationVector

Type: string

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

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

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

The AWS 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

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

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

Type: string

The ARN of the secret that you created in AWS 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

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.

Entitlement

Description

The settings for a flow entitlement.

Members

DataTransferSubscriberFeePercent

Type: int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

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.

EntitlementStatus

Type: string

An indication of whether the entitlement is enabled.

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.

FailoverConfig

Description

The settings for source failover

Members

FailoverMode

Type: string

The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.

RecoveryWindow

Type: int

Search window time to look for dash-7 packets

SourcePriority

Type: SourcePriority structure

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.

State

Type: string

Flow

Description

The settings for a flow, including its source, outputs, and entitlements.

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.

MediaStreams

Type: Array of MediaStream structures

The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on 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.

SourceFailoverConfig

Type: FailoverConfig structure

The settings for source failover

Sources

Type: Array of Source structures

Status

Required: Yes
Type: string

The current status of the flow.

VpcInterfaces

Type: Array of VpcInterface structures

The VPC Interfaces for this flow.

Fmtp

Description

FMTP

Members

ChannelOrder

Type: string

The format of the audio channel.

Colorimetry

Type: string

The format that is used for the representation of color.

ExactFramerate

Type: string

The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.

Par

Type: string

The pixel aspect ratio (PAR) of the video.

Range

Type: string

The encoding range of the video.

ScanMode

Type: string

The type of compression that was used to smooth the video’s appearance

Tcs

Type: string

The transfer characteristic system (TCS) that is used in the video.

FmtpRequest

Description

The settings that you want to use to define the media stream.

Members

ChannelOrder

Type: string

The format of the audio channel.

Colorimetry

Type: string

The format that is used for the representation of color.

ExactFramerate

Type: string

Par

Type: string

The pixel aspect ratio (PAR) of the video.

Range

Type: string

The encoding range of the video.

ScanMode

Type: string

The type of compression that was used to smooth the video’s appearance.

Tcs

Type: string

The transfer characteristic system (TCS) that is used in the video.

ForbiddenException

Description

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

Members

Message

Required: Yes
Type: string

GrantEntitlementRequest

Description

The entitlements that you want to grant on a flow.

Members

DataTransferSubscriberFeePercent

Type: int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

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.

EntitlementStatus

Type: string

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

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

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

Members

Message

Required: Yes
Type: string

InputConfiguration

Description

The transport parameters that are associated with an incoming media stream.

Members

InputIp

Required: Yes
Type: string

The IP address that the flow listens on for incoming content for a media stream.

InputPort

Required: Yes
Type: int

The port that the flow listens on for an incoming media stream.

Interface

Required: Yes
Type: Interface structure

The VPC interface where the media stream comes in from.

InputConfigurationRequest

Description

The transport parameters that you want to associate with an incoming media stream.

Members

InputPort

Required: Yes
Type: int

The port that you want the flow to listen on for an incoming media stream.

Interface

Required: Yes
Type: InterfaceRequest structure

The VPC interface that you want to use for the incoming media stream.

Interface

Description

The VPC interface that is used for the media stream associated with the source or output.

Members

Name

Required: Yes
Type: string

The name of the VPC interface.

InterfaceRequest

Description

The VPC interface that you want to designate where the media stream is coming from or going to.

Members

Name

Required: Yes
Type: string

The name of the VPC interface.

InternalServerErrorException

Description

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

Members

Message

Required: Yes
Type: string

ListedEntitlement

Description

An entitlement that has been granted to you from other AWS accounts.

Members

DataTransferSubscriberFeePercent

Type: int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

EntitlementArn

Required: Yes
Type: string

The ARN of the entitlement.

EntitlementName

Required: Yes
Type: string

The name of the entitlement.

ListedFlow

Description

Provides a summary of a flow, including its ARN, Availability Zone, and source type.

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.

MediaStream

Description

A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.

Members

Attributes

Type: MediaStreamAttributes structure

Attributes that are related to the media stream.

ClockRate

Type: int

The sample rate for the stream. This value is measured in Hz.

Description

Type: string

A description that can help you quickly identify what your media stream is used for.

Fmt

Required: Yes
Type: int

The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

MediaStreamId

Required: Yes
Type: int

A unique identifier for the media stream.

MediaStreamName

Required: Yes
Type: string

A name that helps you distinguish one media stream from another.

MediaStreamType

Required: Yes
Type: string

The type of media stream.

VideoFormat

Type: string

The resolution of the video.

MediaStreamAttributes

Description

Attributes that are related to the media stream.

Members

Fmtp

Required: Yes
Type: Fmtp structure

A set of parameters that define the media stream.

Lang

Type: string

The audio language, in a format that is recognized by the receiver.

MediaStreamAttributesRequest

Description

Attributes that are related to the media stream.

Members

Fmtp

Type: FmtpRequest structure

The settings that you want to use to define the media stream.

Lang

Type: string

The audio language, in a format that is recognized by the receiver.

MediaStreamOutputConfiguration

Description

The media stream that is associated with the output, and the parameters for that association.

Members

DestinationConfigurations

Type: Array of DestinationConfiguration structures

The transport parameters that are associated with each outbound media stream.

EncodingName

Required: Yes
Type: string

The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

EncodingParameters

Type: EncodingParameters structure

Encoding parameters

MediaStreamName

Required: Yes
Type: string

The name of the media stream.

MediaStreamOutputConfigurationRequest

Description

The media stream that you want to associate with the output, and the parameters for that association.

Members

DestinationConfigurations

Type: Array of DestinationConfigurationRequest structures

The transport parameters that you want to associate with the media stream.

EncodingName

Required: Yes
Type: string

The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

EncodingParameters

Type: EncodingParametersRequest structure

A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.

MediaStreamName

Required: Yes
Type: string

The name of the media stream that is associated with the output.

MediaStreamSourceConfiguration

Description

The media stream that is associated with the source, and the parameters for that association.

Members

EncodingName

Required: Yes
Type: string

InputConfigurations

Type: Array of InputConfiguration structures

The transport parameters that are associated with an incoming media stream.

MediaStreamName

Required: Yes
Type: string

The name of the media stream.

MediaStreamSourceConfigurationRequest

Description

The definition of a media stream that you want to associate with the source.

Members

EncodingName

Required: Yes
Type: string

The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

InputConfigurations

Type: Array of InputConfigurationRequest structures

The transport parameters that you want to associate with the media stream.

MediaStreamName

Required: Yes
Type: string

The name of the media stream.

Messages

Description

Messages that provide the state of the flow.

Members

Errors

Required: Yes
Type: Array of strings

A list of errors that might have been generated from processes on this flow.

NotFoundException

Description

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

Members

Message

Required: Yes
Type: string

Offering

Description

A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.

Members

CurrencyCode

Required: Yes
Type: string

The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.

Duration

Required: Yes
Type: int

The length of time that your reservation would be active.

DurationUnits

Required: Yes
Type: string

The unit of measurement for the duration of the offering.

OfferingArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.

OfferingDescription

Required: Yes
Type: string

A description of the offering.

PricePerUnit

Required: Yes
Type: string

The cost of a single unit. This value, in combination with priceUnits, makes up the rate.

PriceUnits

Required: Yes
Type: string

The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.

ResourceSpecification

Required: Yes
Type: ResourceSpecification structure

A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.

Output

Description

The settings for an output.

Members

DataTransferSubscriberFeePercent

Type: int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

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.

ListenerAddress

Type: string

The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.

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.

MediaStreamOutputConfigurations

Type: Array of MediaStreamOutputConfiguration structures

The configuration for each media stream that is associated with the output.

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.

VpcInterfaceAttachment

Type: VpcInterfaceAttachment structure

The name of the VPC interface attachment to use for this output.

Reservation

Description

Members

CurrencyCode

Required: Yes
Type: string

The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.

Duration

Required: Yes
Type: int

The length of time that this reservation is active. MediaConnect defines this value in the offering.

DurationUnits

Required: Yes
Type: string

The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.

End

Required: Yes
Type: string

The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.

OfferingArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.

OfferingDescription

Required: Yes
Type: string

A description of the offering. MediaConnect defines this value in the offering.

PricePerUnit

Required: Yes
Type: string

The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.

PriceUnits

Required: Yes
Type: string

The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.

ReservationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.

ReservationName

Required: Yes
Type: string

The name that you assigned to the reservation when you purchased the offering.

ReservationState

Required: Yes
Type: string

The status of your reservation.

ResourceSpecification

Required: Yes
Type: ResourceSpecification structure

A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.

Start

Required: Yes
Type: string

The day and time that the reservation becomes active. You set this value when you purchase the offering.

ResourceSpecification

Description

A definition of what is being billed for, including the type and amount.

Members

ReservedBitrate

Type: int

The amount of outbound bandwidth that is discounted in the offering.

ResourceType

Required: Yes
Type: string

The type of resource and the unit that is being billed for.

ResponseError

Description

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

Members

Message

Required: Yes
Type: string

The error message returned by AWS Elemental MediaConnect.

ServiceUnavailableException

Description

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

Members

Message

Required: Yes
Type: string

SetSourceRequest

Description

The settings for the source of the flow.

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 RIST, RTP, and RTP-FEC streams.

MaxLatency

Type: int

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

MaxSyncBuffer

Type: int

The size of the buffer (in milliseconds) to use to sync incoming source data.

MediaStreamSourceConfigurations

Type: Array of MediaStreamSourceConfigurationRequest structures

The media streams that are associated with the source, and the parameters for those associations.

MinLatency

Type: int

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.

VpcInterfaceName

Type: string

The name of the VPC interface to use for this source.

WhitelistCidr

Type: string

Source

Description

The settings for the source of the flow.

Members

DataTransferSubscriberFeePercent

Type: int

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

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.

MediaStreamSourceConfigurations

Type: Array of MediaStreamSourceConfiguration structures

The media streams that are associated with the source, and the parameters for those associations.

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.

VpcInterfaceName

Type: string

The name of the VPC interface that is used for this source.

WhitelistCidr

Type: string

SourcePriority

Description

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.

Members

PrimarySource

Type: string

The name of the source you choose as the primary source for this flow.

TooManyRequestsException

Description

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

Members

Message

Required: Yes
Type: string

Transport

Description

Attributes related to the transport stream that are used in a source or output.

Members

CidrAllowList

Type: Array of strings

MaxBitrate

Type: int

The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

MaxLatency

Type: int

The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.

MaxSyncBuffer

Type: int

The size of the buffer (in milliseconds) to use to sync incoming source data.

MinLatency

Type: int

Protocol

Required: Yes
Type: string

The protocol that is used by the source or output.

RemoteId

Type: string

The remote ID for the Zixi-pull stream.

SmoothingLatency

Type: int

The smoothing latency in milliseconds for RIST, 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

Information about the encryption of the flow.

Members

Algorithm

Type: string

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

ConstantInitializationVector

Type: string

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

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).

Region

Type: string

The AWS 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

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 of the secret that you created in AWS 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

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.

UpdateFailoverConfig

Description

The settings for source failover

Members

FailoverMode

Type: string

RecoveryWindow

Type: int

Recovery window time to look for dash-7 packets

SourcePriority

Type: SourcePriority structure

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.

State

Type: string

VpcInterface

Description

The settings for a VPC Source.

Members

Name

Required: Yes
Type: string

Immutable and has to be a unique against other VpcInterfaces in this Flow

NetworkInterfaceIds

Required: Yes
Type: Array of strings

IDs of the network interfaces created in customer's account by MediaConnect.

NetworkInterfaceType

Required: Yes
Type: string

The type of network interface.

RoleArn

Required: Yes
Type: string

Role Arn MediaConnect can assumes to create ENIs in customer's account

SecurityGroupIds

Required: Yes
Type: Array of strings

Security Group IDs to be used on ENI.

SubnetId

Required: Yes
Type: string

Subnet must be in the AZ of the Flow

VpcInterfaceAttachment

Description

The settings for attaching a VPC interface to an output.

Members

VpcInterfaceName

Type: string

The name of the VPC interface to use for this output.

VpcInterfaceRequest

Description

Desired VPC Interface for a Flow

Members

Name

Required: Yes
Type: string

The name of the VPC Interface. This value must be unique within the current flow.

NetworkInterfaceType

Type: string

The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType.

RoleArn

Required: Yes
Type: string

Role Arn MediaConnect can assumes to create ENIs in customer's account

SecurityGroupIds

Required: Yes
Type: Array of strings

Security Group IDs to be used on ENI.

SubnetId

Required: Yes
Type: string

Subnet must be in the AZ of the Flow

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS MediaConnect 2018-11-14

Operation Summary

Paginators

Waiters

Operations

AddFlowMediaStreams

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddFlowOutputs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddFlowSources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddFlowVpcInterfaces

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFlow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteFlow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeFlow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeOffering

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeReservation

Parameter Syntax

Parameter Details

Members

Result Syntax