SDK for PHP 3.x
AWS MediaConnect 2018-11-14
- Client: Aws\MediaConnect\MediaConnectClient
- Service ID: mediaconnect
- Version: 2018-11-14
This page describes the parameters and results for the operations of the AWS MediaConnect (2018-11-14), and shows how to use the Aws\MediaConnect\MediaConnectClient object to call the described operations. This documentation is specific to the 2018-11-14 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AddBridgeOutputs ( array $params = [] )
- Adds outputs to an existing bridge.
- AddBridgeSources ( array $params = [] )
- Adds sources to an existing bridge.
- 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 a flow.
- AddFlowVpcInterfaces ( array $params = [] )
- Adds VPC interfaces to a flow.
- CreateBridge ( array $params = [] )
- Creates a new bridge.
- CreateFlow ( array $params = [] )
- Creates a new flow.
- CreateGateway ( array $params = [] )
- Creates a new gateway.
- DeleteBridge ( array $params = [] )
- Deletes a bridge.
- DeleteFlow ( array $params = [] )
- Deletes a flow.
- DeleteGateway ( array $params = [] )
- Deletes a gateway.
- DeregisterGatewayInstance ( array $params = [] )
- Deregisters an instance.
- DescribeBridge ( array $params = [] )
- Displays the details of a bridge.
- DescribeFlow ( array $params = [] )
- Displays the details of a flow.
- DescribeFlowSourceMetadata ( array $params = [] )
- The DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs.
- DescribeFlowSourceThumbnail ( array $params = [] )
- Describes the thumbnail for the flow source.
- DescribeGateway ( array $params = [] )
- Displays the details of a gateway.
- DescribeGatewayInstance ( array $params = [] )
- Displays the details of an instance.
- 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.
- ListBridges ( array $params = [] )
- Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN).
- 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.
- ListGatewayInstances ( array $params = [] )
- Displays a list of instances associated with the Amazon Web Services account.
- ListGateways ( array $params = [] )
- Displays a list of gateways that are associated with this account.
- ListOfferings ( array $params = [] )
- Displays a list of all offerings that are available to this account in the current Amazon Web Services Region.
- ListReservations ( array $params = [] )
- Displays a list of all reservations that have been purchased by this account in the current Amazon Web Services Region.
- ListTagsForResource ( array $params = [] )
- List all tags on a MediaConnect resource.
- PurchaseOffering ( array $params = [] )
- Submits a request to purchase an offering.
- RemoveBridgeOutput ( array $params = [] )
- Removes an output from a bridge.
- RemoveBridgeSource ( array $params = [] )
- Removes a source from a bridge.
- 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.
- UpdateBridge ( array $params = [] )
- Updates the bridge.
- UpdateBridgeOutput ( array $params = [] )
- Updates an existing bridge output.
- UpdateBridgeSource ( array $params = [] )
- Updates an existing bridge source.
- UpdateBridgeState ( array $params = [] )
- Updates the bridge state.
- UpdateFlow ( array $params = [] )
- Updates an existing flow.
- UpdateFlowEntitlement ( array $params = [] )
- Updates an entitlement.
- 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.
- UpdateGatewayInstance ( array $params = [] )
- Updates an existing gateway instance.
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:
- ListBridges
- ListEntitlements
- ListFlows
- ListGatewayInstances
- ListGateways
- 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 |
| FlowDeleted | DescribeFlow | 3 | 40 |
| FlowStandby | DescribeFlow | 3 | 40 |
Operations
AddBridgeOutputs
$result = $client->addBridgeOutputs([/* ... */]); $promise = $client->addBridgeOutputsAsync([/* ... */]);
Adds outputs to an existing bridge.
Parameter Syntax
$result = $client->addBridgeOutputs([
'BridgeArn' => '<string>', // REQUIRED
'Outputs' => [ // REQUIRED
[
'NetworkOutput' => [
'IpAddress' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
'Ttl' => <integer>, // REQUIRED
],
],
// ...
],
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- Outputs
-
- Required: Yes
- Type: Array of AddBridgeOutputRequest structures
The outputs that you want to add to this bridge.
Result Syntax
[
'BridgeArn' => '<string>',
'Outputs' => [
[
'FlowOutput' => [
'FlowArn' => '<string>',
'FlowSourceArn' => '<string>',
'Name' => '<string>',
],
'NetworkOutput' => [
'IpAddress' => '<string>',
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
],
// ...
],
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the bridge that you added outputs to.
- Outputs
-
- Type: Array of BridgeOutput structures
The outputs that you added to this bridge.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
AddBridgeSources
$result = $client->addBridgeSources([/* ... */]); $promise = $client->addBridgeSourcesAsync([/* ... */]);
Adds sources to an existing bridge.
Parameter Syntax
$result = $client->addBridgeSources([
'BridgeArn' => '<string>', // REQUIRED
'Sources' => [ // REQUIRED
[
'FlowSource' => [
'FlowArn' => '<string>', // REQUIRED
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>', // REQUIRED
],
'NetworkSource' => [
'MulticastIp' => '<string>', // REQUIRED
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>', // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
],
],
// ...
],
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- Sources
-
- Required: Yes
- Type: Array of AddBridgeSourceRequest structures
The sources that you want to add to this bridge.
Result Syntax
[
'BridgeArn' => '<string>',
'Sources' => [
[
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>',
'OutputArn' => '<string>',
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
],
// ...
],
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the bridge that you added sources to.
- Sources
-
- Type: Array of BridgeSource structures
The sources that you added to this bridge.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow.
- 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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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>',
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'OutputStatus' => 'ENABLED|DISABLED',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SmoothingLatency' => <integer>,
'StreamId' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
// ...
],
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow that you want to add outputs to.
- Outputs
-
- Required: Yes
- Type: Array of AddOutputRequest structures
A list of outputs that you want to add to the flow.
Result Syntax
[
'FlowArn' => '<string>',
'Outputs' => [
[
'BridgeArn' => '<string>',
'BridgePorts' => [<integer>, ...],
'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>',
'OutputStatus' => 'ENABLED|DISABLED',
'PeerIpAddress' => '<string>',
'Port' => <integer>,
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- AddFlowOutputs420Exception:
Exception raised by Elemental MediaConnect when adding the flow output. See the error message for the operation for more information on the cause of this exception.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
AddFlowSources
$result = $client->addFlowSources([/* ... */]); $promise = $client->addFlowSourcesAsync([/* ... */]);
Adds sources to a 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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>', // REQUIRED
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<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|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow that you want to update.
- Sources
-
- Required: Yes
- Type: Array of SetSourceRequest structures
A list of sources that you want to add to the flow.
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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
AddFlowVpcInterfaces
$result = $client->addFlowVpcInterfaces([/* ... */]); $promise = $client->addFlowVpcInterfacesAsync([/* ... */]);
Adds VPC interfaces to a 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
The Amazon Resource Name (ARN) of the flow that you want to update.
- VpcInterfaces
-
- Required: Yes
- Type: Array of VpcInterfaceRequest structures
A list of VPC interfaces that you want to add to the flow.
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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
CreateBridge
$result = $client->createBridge([/* ... */]); $promise = $client->createBridgeAsync([/* ... */]);
Creates a new bridge. The request must include one source.
Parameter Syntax
$result = $client->createBridge([
'EgressGatewayBridge' => [
'MaxBitrate' => <integer>, // REQUIRED
],
'IngressGatewayBridge' => [
'MaxBitrate' => <integer>, // REQUIRED
'MaxOutputs' => <integer>, // REQUIRED
],
'Name' => '<string>', // REQUIRED
'Outputs' => [
[
'NetworkOutput' => [
'IpAddress' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
'Ttl' => <integer>, // REQUIRED
],
],
// ...
],
'PlacementArn' => '<string>', // REQUIRED
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'Sources' => [ // REQUIRED
[
'FlowSource' => [
'FlowArn' => '<string>', // REQUIRED
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>', // REQUIRED
],
'NetworkSource' => [
'MulticastIp' => '<string>', // REQUIRED
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>', // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
],
],
// ...
],
]);
Parameter Details
Members
- EgressGatewayBridge
-
- Type: AddEgressGatewayBridgeRequest structure
An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
- IngressGatewayBridge
-
- Type: AddIngressGatewayBridgeRequest structure
An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
- Name
-
- Required: Yes
- Type: string
The name of the bridge. This name can not be modified after the bridge is created.
- Outputs
-
- Type: Array of AddBridgeOutputRequest structures
The outputs that you want to add to this bridge.
- PlacementArn
-
- Required: Yes
- Type: string
The bridge placement Amazon Resource Number (ARN).
- SourceFailoverConfig
-
- Type: FailoverConfig structure
The settings for source failover.
- Sources
-
- Required: Yes
- Type: Array of AddBridgeSourceRequest structures
The sources that you want to add to this bridge.
Result Syntax
[
'Bridge' => [
'BridgeArn' => '<string>',
'BridgeMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'BridgeState' => 'CREATING|STANDBY|STARTING|DEPLOYING|ACTIVE|STOPPING|DELETING|DELETED|START_FAILED|START_PENDING|STOP_FAILED|UPDATING',
'EgressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
],
'IngressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
'MaxOutputs' => <integer>,
],
'Name' => '<string>',
'Outputs' => [
[
'FlowOutput' => [
'FlowArn' => '<string>',
'FlowSourceArn' => '<string>',
'Name' => '<string>',
],
'NetworkOutput' => [
'IpAddress' => '<string>',
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
],
// ...
],
'PlacementArn' => '<string>',
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'Sources' => [
[
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>',
'OutputArn' => '<string>',
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
],
// ...
],
],
]
Result Details
Members
- Bridge
-
- Type: Bridge structure
The name of the bridge that was created.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- CreateBridge420Exception:
Exception raised by Elemental MediaConnect when creating the bridge. See the error message for the operation for more information on the cause of this exception.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
],
// ...
],
'FlowSize' => 'MEDIUM|LARGE',
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday', // REQUIRED
'MaintenanceStartHour' => '<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
'NdiConfig' => [
'MachineName' => '<string>',
'NdiDiscoveryServers' => [
[
'DiscoveryServerAddress' => '<string>', // REQUIRED
'DiscoveryServerPort' => <integer>,
'VpcInterfaceAdapter' => '<string>', // REQUIRED
],
// ...
],
'NdiState' => 'ENABLED|DISABLED',
],
'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>',
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'OutputStatus' => 'ENABLED|DISABLED',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq', // REQUIRED
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>', // REQUIRED
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<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|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'SourceMonitoringConfig' => [
'AudioMonitoringSettings' => [
[
'SilentAudio' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
'ContentQualityAnalysisState' => 'ENABLED|DISABLED',
'ThumbnailState' => 'ENABLED|DISABLED',
'VideoMonitoringSettings' => [
[
'BlackFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
'FrozenFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
],
'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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>', // REQUIRED
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<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|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'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 Amazon Web Services Region.
- Entitlements
-
- Type: Array of GrantEntitlementRequest structures
The entitlements that you want to grant on a flow.
- FlowSize
-
- Type: string
Determines the processing capacity and feature set of the flow. Set this optional parameter to
LARGEif you want to enable NDI outputs on the flow. - Maintenance
-
- Type: AddMaintenance structure
The maintenance settings you want to use for the 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.
- NdiConfig
-
- Type: NdiConfig structure
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
- 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 that you want to use for the new flow.
- SourceFailoverConfig
-
- Type: FailoverConfig structure
The settings for source failover.
- SourceMonitoringConfig
-
- Type: MonitoringConfig structure
The settings for source monitoring.
- Sources
-
- Type: Array of SetSourceRequest structures
The sources that are assigned to the flow.
- 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>',
'FlowSize' => 'MEDIUM|LARGE',
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartHour' => '<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>',
'NdiConfig' => [
'MachineName' => '<string>',
'NdiDiscoveryServers' => [
[
'DiscoveryServerAddress' => '<string>',
'DiscoveryServerPort' => <integer>,
'VpcInterfaceAdapter' => '<string>',
],
// ...
],
'NdiState' => 'ENABLED|DISABLED',
],
'Outputs' => [
[
'BridgeArn' => '<string>',
'BridgePorts' => [<integer>, ...],
'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>',
'OutputStatus' => 'ENABLED|DISABLED',
'PeerIpAddress' => '<string>',
'Port' => <integer>,
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
],
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'SourceMonitoringConfig' => [
'AudioMonitoringSettings' => [
[
'SilentAudio' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
'ContentQualityAnalysisState' => 'ENABLED|DISABLED',
'ThumbnailState' => 'ENABLED|DISABLED',
'VideoMonitoringSettings' => [
[
'BlackFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
'FrozenFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
],
'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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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 flow that you created.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
- CreateFlow420Exception:
Exception raised by Elemental MediaConnect when creating the flow. See the error message for the operation for more information on the cause of this exception.
CreateGateway
$result = $client->createGateway([/* ... */]); $promise = $client->createGatewayAsync([/* ... */]);
Creates a new gateway. The request must include at least one network (up to four).
Parameter Syntax
$result = $client->createGateway([
'EgressCidrBlocks' => ['<string>', ...], // REQUIRED
'Name' => '<string>', // REQUIRED
'Networks' => [ // REQUIRED
[
'CidrBlock' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- EgressCidrBlocks
-
- Required: Yes
- Type: Array of strings
The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
- Name
-
- Required: Yes
- Type: string
The name of the gateway. This name can not be modified after the gateway is created.
- Networks
-
- Required: Yes
- Type: Array of GatewayNetwork structures
The list of networks that you want to add to the gateway.
Result Syntax
[
'Gateway' => [
'EgressCidrBlocks' => ['<string>', ...],
'GatewayArn' => '<string>',
'GatewayMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'GatewayState' => 'CREATING|ACTIVE|UPDATING|ERROR|DELETING|DELETED',
'Name' => '<string>',
'Networks' => [
[
'CidrBlock' => '<string>',
'Name' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Gateway
-
- Type: Gateway structure
The gateway that you created.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- CreateGateway420Exception:
Exception raised by Elemental MediaConnect when creating the gateway. See the error message for the operation for more information on the cause of this exception.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DeleteBridge
$result = $client->deleteBridge([/* ... */]); $promise = $client->deleteBridgeAsync([/* ... */]);
Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
Parameter Syntax
$result = $client->deleteBridge([
'BridgeArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to delete.
Result Syntax
[
'BridgeArn' => '<string>',
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the deleted bridge.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to delete.
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
DeleteFlowprocess begins.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DeleteGateway
$result = $client->deleteGateway([/* ... */]); $promise = $client->deleteGatewayAsync([/* ... */]);
Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
Parameter Syntax
$result = $client->deleteGateway([
'GatewayArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- GatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway that you want to delete.
Result Syntax
[
'GatewayArn' => '<string>',
]
Result Details
Members
- GatewayArn
-
- Type: string
The ARN of the gateway that was deleted.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DeregisterGatewayInstance
$result = $client->deregisterGatewayInstance([/* ... */]); $promise = $client->deregisterGatewayInstanceAsync([/* ... */]);
Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.
Parameter Syntax
$result = $client->deregisterGatewayInstance([
'Force' => true || false,
'GatewayInstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Force
-
- Type: boolean
Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
- GatewayInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
Result Syntax
[
'GatewayInstanceArn' => '<string>',
'InstanceState' => 'REGISTERING|ACTIVE|DEREGISTERING|DEREGISTERED|REGISTRATION_ERROR|DEREGISTRATION_ERROR',
]
Result Details
Members
- GatewayInstanceArn
-
- Type: string
The ARN of the instance.
- InstanceState
-
- Type: string
The status of the instance.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeBridge
$result = $client->describeBridge([/* ... */]); $promise = $client->describeBridgeAsync([/* ... */]);
Displays the details of a bridge.
Parameter Syntax
$result = $client->describeBridge([
'BridgeArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to describe.
Result Syntax
[
'Bridge' => [
'BridgeArn' => '<string>',
'BridgeMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'BridgeState' => 'CREATING|STANDBY|STARTING|DEPLOYING|ACTIVE|STOPPING|DELETING|DELETED|START_FAILED|START_PENDING|STOP_FAILED|UPDATING',
'EgressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
],
'IngressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
'MaxOutputs' => <integer>,
],
'Name' => '<string>',
'Outputs' => [
[
'FlowOutput' => [
'FlowArn' => '<string>',
'FlowSourceArn' => '<string>',
'Name' => '<string>',
],
'NetworkOutput' => [
'IpAddress' => '<string>',
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
],
// ...
],
'PlacementArn' => '<string>',
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'Sources' => [
[
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>',
'OutputArn' => '<string>',
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
],
// ...
],
],
]
Result Details
Members
- Bridge
-
- Type: Bridge structure
The bridge that you requested a description of.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeFlow
$result = $client->describeFlow([/* ... */]); $promise = $client->describeFlowAsync([/* ... */]);
Displays the details of a flow. The response includes the flow Amazon Resource Name (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
The ARN of the flow that you want to describe.
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>',
'FlowSize' => 'MEDIUM|LARGE',
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartHour' => '<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>',
'NdiConfig' => [
'MachineName' => '<string>',
'NdiDiscoveryServers' => [
[
'DiscoveryServerAddress' => '<string>',
'DiscoveryServerPort' => <integer>,
'VpcInterfaceAdapter' => '<string>',
],
// ...
],
'NdiState' => 'ENABLED|DISABLED',
],
'Outputs' => [
[
'BridgeArn' => '<string>',
'BridgePorts' => [<integer>, ...],
'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>',
'OutputStatus' => 'ENABLED|DISABLED',
'PeerIpAddress' => '<string>',
'Port' => <integer>,
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
],
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'SourceMonitoringConfig' => [
'AudioMonitoringSettings' => [
[
'SilentAudio' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
'ContentQualityAnalysisState' => 'ENABLED|DISABLED',
'ThumbnailState' => 'ENABLED|DISABLED',
'VideoMonitoringSettings' => [
[
'BlackFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
'FrozenFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
],
'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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeFlowSourceMetadata
$result = $client->describeFlowSourceMetadata([/* ... */]); $promise = $client->describeFlowSourceMetadataAsync([/* ... */]);
The DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data.
Parameter Syntax
$result = $client->describeFlowSourceMetadata([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow.
Result Syntax
[
'FlowArn' => '<string>',
'Messages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'Timestamp' => <DateTime>,
'TransportMediaInfo' => [
'Programs' => [
[
'PcrPid' => <integer>,
'ProgramName' => '<string>',
'ProgramNumber' => <integer>,
'ProgramPid' => <integer>,
'Streams' => [
[
'Channels' => <integer>,
'Codec' => '<string>',
'FrameRate' => '<string>',
'FrameResolution' => [
'FrameHeight' => <integer>,
'FrameWidth' => <integer>,
],
'Pid' => <integer>,
'SampleRate' => <integer>,
'SampleSize' => <integer>,
'StreamType' => '<string>',
],
// ...
],
],
// ...
],
],
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that DescribeFlowSourceMetadata was performed on.
- Messages
-
- Type: Array of MessageDetail structures
Provides a status code and message regarding issues found with the flow source metadata.
- Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the most recent change in metadata for this flow’s source.
- TransportMediaInfo
-
- Type: TransportMediaInfo structure
Information about the flow's transport media.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeFlowSourceThumbnail
$result = $client->describeFlowSourceThumbnail([/* ... */]); $promise = $client->describeFlowSourceThumbnailAsync([/* ... */]);
Describes the thumbnail for the flow source.
Parameter Syntax
$result = $client->describeFlowSourceThumbnail([
'FlowArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow.
Result Syntax
[
'ThumbnailDetails' => [
'FlowArn' => '<string>',
'Thumbnail' => '<string>',
'ThumbnailMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'Timecode' => '<string>',
'Timestamp' => <DateTime>,
],
]
Result Details
Members
- ThumbnailDetails
-
- Type: ThumbnailDetails structure
The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeGateway
$result = $client->describeGateway([/* ... */]); $promise = $client->describeGatewayAsync([/* ... */]);
Displays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name, and CIDR blocks, as well as details about the networks.
Parameter Syntax
$result = $client->describeGateway([
'GatewayArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- GatewayArn
-
- Required: Yes
- Type: string
The ARN of the gateway that you want to describe.
Result Syntax
[
'Gateway' => [
'EgressCidrBlocks' => ['<string>', ...],
'GatewayArn' => '<string>',
'GatewayMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'GatewayState' => 'CREATING|ACTIVE|UPDATING|ERROR|DELETING|DELETED',
'Name' => '<string>',
'Networks' => [
[
'CidrBlock' => '<string>',
'Name' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Gateway
-
- Type: Gateway structure
The gateway that you wanted to describe.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
DescribeGatewayInstance
$result = $client->describeGatewayInstance([/* ... */]); $promise = $client->describeGatewayInstanceAsync([/* ... */]);
Displays the details of an instance.
Parameter Syntax
$result = $client->describeGatewayInstance([
'GatewayInstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- GatewayInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
Result Syntax
[
'GatewayInstance' => [
'BridgePlacement' => 'AVAILABLE|LOCKED',
'ConnectionStatus' => 'CONNECTED|DISCONNECTED',
'GatewayArn' => '<string>',
'GatewayInstanceArn' => '<string>',
'InstanceId' => '<string>',
'InstanceMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'InstanceState' => 'REGISTERING|ACTIVE|DEREGISTERING|DEREGISTERED|REGISTRATION_ERROR|DEREGISTRATION_ERROR',
'RunningBridgeCount' => <integer>,
],
]
Result Details
Members
- GatewayInstance
-
- Type: GatewayInstance structure
The gateway instance that you requested a description of.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The ARN of the offering.
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
The offering that you requested a description of.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the offering.
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
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to grant entitlements on.
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
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- GrantFlowEntitlements420Exception:
Exception raised by Elemental MediaConnect when granting the entitlement. See the error message for the operation for more information on the cause of this exception.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListBridges
$result = $client->listBridges([/* ... */]); $promise = $client->listBridgesAsync([/* ... */]);
Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result.
Parameter Syntax
$result = $client->listBridges([
'FilterArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- FilterArn
-
- Type: string
Filter the list results to display only the bridges associated with the selected ARN.
- MaxResults
-
- Type: int
The maximum number of results to return per API request.
For example, you submit a
ListBridgesrequest withMaxResultsset at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListBridgesrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListBridgesrequest a second time and specify theNextTokenvalue.
Result Syntax
[
'Bridges' => [
[
'BridgeArn' => '<string>',
'BridgeState' => 'CREATING|STANDBY|STARTING|DEPLOYING|ACTIVE|STOPPING|DELETING|DELETED|START_FAILED|START_PENDING|STOP_FAILED|UPDATING',
'BridgeType' => '<string>',
'Name' => '<string>',
'PlacementArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Bridges
-
- Type: Array of ListedBridge structures
A list of bridge summaries.
- NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListBridgesrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListBridgesrequest a second time and specify theNextTokenvalue.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The maximum number of results to return per API request.
For example, you submit a
ListEntitlementsrequest with set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 20 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListEntitlementsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListEntitlementsrequest a second time and specify theNextTokenvalue.
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 Amazon Web Services accounts.
- NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a ListEntitlements request with
MaxResultsset 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 theListEntitlementsrequest a second time and specify theNextTokenvalue.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The maximum number of results to return per API request.
For example, you submit a
ListFlowsrequest with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListFlowsrequest with MaxResults set at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListFlowsrequest a second time and specify theNextTokenvalue.
Result Syntax
[
'Flows' => [
[
'AvailabilityZone' => '<string>',
'Description' => '<string>',
'FlowArn' => '<string>',
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartHour' => '<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 the batch of results that you want to see.
For example, you submit a
ListFlowsrequest with MaxResults set at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListFlowsrequest a second time and specify theNextTokenvalue.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListGatewayInstances
$result = $client->listGatewayInstances([/* ... */]); $promise = $client->listGatewayInstancesAsync([/* ... */]);
Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->listGatewayInstances([
'FilterArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- FilterArn
-
- Type: string
Filter the list results to display only the instances associated with the selected Gateway ARN.
- MaxResults
-
- Type: int
The maximum number of results to return per API request.
For example, you submit a ListInstances request with
MaxResultsset at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListInstancesrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListInstancesrequest a second time and specify theNextTokenvalue.
Result Syntax
[
'Instances' => [
[
'GatewayArn' => '<string>',
'GatewayInstanceArn' => '<string>',
'InstanceId' => '<string>',
'InstanceState' => 'REGISTERING|ACTIVE|DEREGISTERING|DEREGISTERED|REGISTRATION_ERROR|DEREGISTRATION_ERROR',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Instances
-
- Type: Array of ListedGatewayInstance structures
A list of instance summaries.
- NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListInstancesrequest with MaxResults set at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListInstancesrequest a second time and specify theNextTokenvalue.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListGateways
$result = $client->listGateways([/* ... */]); $promise = $client->listGatewaysAsync([/* ... */]);
Displays a list of gateways that are associated with this account. This request returns a paginated result.
Parameter Syntax
$result = $client->listGateways([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return per API request.
For example, you submit a
ListGatewaysrequest withMaxResultsset at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListGatewaysrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListGatewaysrequest a second time and specify theNextTokenvalue.
Result Syntax
[
'Gateways' => [
[
'GatewayArn' => '<string>',
'GatewayState' => 'CREATING|ACTIVE|UPDATING|ERROR|DELETING|DELETED',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Gateways
-
- Type: Array of ListedGateway structures
A list of gateway summaries.
- NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListGatewaysrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListGatewaysrequest a second time and specify theNextTokenvalue.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListOfferings
$result = $client->listOfferings([/* ... */]); $promise = $client->listOfferingsAsync([/* ... */]);
Displays a list of all offerings that are available to this account in the current Amazon Web Services 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
The maximum number of results to return per API request.
For example, you submit a
ListOfferingsrequest withMaxResultsset at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns aNextTokenvalue that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListOfferingsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListOfferingsrequest a second time and specify theNextTokenvalue.
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 the batch of results that you want to see.
For example, you submit a
ListOfferingsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListOfferingsrequest a second time and specify theNextTokenvalue. - Offerings
-
- Type: Array of Offering structures
A list of offerings that are available to this account in the current Amazon Web Services Region.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListReservations
$result = $client->listReservations([/* ... */]); $promise = $client->listReservationsAsync([/* ... */]);
Displays a list of all reservations that have been purchased by this account in the current Amazon Web Services 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
The maximum number of results to return per API request.
For example, you submit a
ListReservationsrequest withMaxResultsset at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 10 results per page. - NextToken
-
- Type: string
The token that identifies the batch of results that you want to see.
For example, you submit a
ListReservationsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListOfferingsrequest a second time and specify theNextTokenvalue.
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 the batch of results that you want to see.
For example, you submit a
ListReservationsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListReservationsrequest a second time and specify theNextTokenvalue. - Reservations
-
- Type: Array of Reservation structures
A list of all reservations that have been purchased by this account in the current Amazon Web Services Region.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- ServiceUnavailableException:
The service is currently unavailable or busy.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List all tags on a MediaConnect resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the MediaConnect resource for which to list the tags.
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
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
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
The Amazon Resource Name (ARN) of the offering.
- 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, whereTandZare literal characters. For example, to specify 11:30pm on March 5, 2020, enter2020-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
The details of the reservation that you just created when you purchased the offering.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
RemoveBridgeOutput
$result = $client->removeBridgeOutput([/* ... */]); $promise = $client->removeBridgeOutputAsync([/* ... */]);
Removes an output from a bridge.
Parameter Syntax
$result = $client->removeBridgeOutput([
'BridgeArn' => '<string>', // REQUIRED
'OutputName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- OutputName
-
- Required: Yes
- Type: string
The name of the bridge output that you want to remove.
Result Syntax
[
'BridgeArn' => '<string>',
'OutputName' => '<string>',
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the bridge from which the output was removed.
- OutputName
-
- Type: string
The name of the bridge output that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
RemoveBridgeSource
$result = $client->removeBridgeSource([/* ... */]); $promise = $client->removeBridgeSourceAsync([/* ... */]);
Removes a source from a bridge.
Parameter Syntax
$result = $client->removeBridgeSource([
'BridgeArn' => '<string>', // REQUIRED
'SourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- SourceName
-
- Required: Yes
- Type: string
The name of the bridge source that you want to remove.
Result Syntax
[
'BridgeArn' => '<string>',
'SourceName' => '<string>',
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the bridge from which the source was removed.
- SourceName
-
- Type: string
The name of the bridge source that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to update.
- MediaStreamName
-
- Required: Yes
- Type: string
The name of the media stream that you want to remove.
Result Syntax
[
'FlowArn' => '<string>',
'MediaStreamName' => '<string>',
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that was updated.
- MediaStreamName
-
- Type: string
The name of the media stream that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to remove an output from.
- OutputArn
-
- Required: Yes
- Type: string
The ARN of the output that you want to remove.
Result Syntax
[
'FlowArn' => '<string>',
'OutputArn' => '<string>',
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that the output was removed from.
- OutputArn
-
- Type: string
The ARN of the output that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to remove a source from.
- SourceArn
-
- Required: Yes
- Type: string
The ARN of the source that you want to remove.
Result Syntax
[
'FlowArn' => '<string>',
'SourceArn' => '<string>',
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that the source was removed from.
- SourceArn
-
- Type: string
The ARN of the source that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to remove a VPC interface from.
- VpcInterfaceName
-
- Required: Yes
- Type: string
The name of the VPC interface that you want to remove.
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 MediaConnect was unable to remove.
- VpcInterfaceName
-
- Type: string
The name of the VPC interface that was removed.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the entitlement that you want to revoke.
- FlowArn
-
- Required: Yes
- Type: string
The flow that you want to revoke an entitlement from.
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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to start.
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
StartFlowprocess begins.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) of the flow that you want to stop.
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
StopFlowprocess begins.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
The Amazon Resource Name (ARN) that identifies the MediaConnect resource to which to add tags.
- 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
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
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
The Amazon Resource Name (ARN) of the resource that you want to untag.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to be removed.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
UpdateBridge
$result = $client->updateBridge([/* ... */]); $promise = $client->updateBridgeAsync([/* ... */]);
Updates the bridge.
Parameter Syntax
$result = $client->updateBridge([
'BridgeArn' => '<string>', // REQUIRED
'EgressGatewayBridge' => [
'MaxBitrate' => <integer>,
],
'IngressGatewayBridge' => [
'MaxBitrate' => <integer>,
'MaxOutputs' => <integer>,
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
TheAmazon Resource Name (ARN) of the bridge that you want to update.
- EgressGatewayBridge
-
- Type: UpdateEgressGatewayBridgeRequest structure
A cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
- IngressGatewayBridge
-
- Type: UpdateIngressGatewayBridgeRequest structure
A ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
- SourceFailoverConfig
-
- Type: UpdateFailoverConfig structure
The settings for source failover.
Result Syntax
[
'Bridge' => [
'BridgeArn' => '<string>',
'BridgeMessages' => [
[
'Code' => '<string>',
'Message' => '<string>',
'ResourceName' => '<string>',
],
// ...
],
'BridgeState' => 'CREATING|STANDBY|STARTING|DEPLOYING|ACTIVE|STOPPING|DELETING|DELETED|START_FAILED|START_PENDING|STOP_FAILED|UPDATING',
'EgressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
],
'IngressGatewayBridge' => [
'InstanceId' => '<string>',
'MaxBitrate' => <integer>,
'MaxOutputs' => <integer>,
],
'Name' => '<string>',
'Outputs' => [
[
'FlowOutput' => [
'FlowArn' => '<string>',
'FlowSourceArn' => '<string>',
'Name' => '<string>',
],
'NetworkOutput' => [
'IpAddress' => '<string>',
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
],
// ...
],
'PlacementArn' => '<string>',
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'Sources' => [
[
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>',
'OutputArn' => '<string>',
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
],
// ...
],
],
]
Result Details
Members
- Bridge
-
- Type: Bridge structure
The bridge that was updated.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateBridgeOutput
$result = $client->updateBridgeOutput([/* ... */]); $promise = $client->updateBridgeOutputAsync([/* ... */]);
Updates an existing bridge output.
Parameter Syntax
$result = $client->updateBridgeOutput([
'BridgeArn' => '<string>', // REQUIRED
'NetworkOutput' => [
'IpAddress' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
'OutputName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- NetworkOutput
-
- Type: UpdateBridgeNetworkOutputRequest structure
The network of the bridge output.
- OutputName
-
- Required: Yes
- Type: string
Tname of the output that you want to update.
Result Syntax
[
'BridgeArn' => '<string>',
'Output' => [
'FlowOutput' => [
'FlowArn' => '<string>',
'FlowSourceArn' => '<string>',
'Name' => '<string>',
],
'NetworkOutput' => [
'IpAddress' => '<string>',
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'Ttl' => <integer>,
],
],
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the bridge that was updated.
- Output
-
- Type: BridgeOutput structure
The bridge output that was updated.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateBridgeSource
$result = $client->updateBridgeSource([/* ... */]); $promise = $client->updateBridgeSourceAsync([/* ... */]);
Updates an existing bridge source.
Parameter Syntax
$result = $client->updateBridgeSource([
'BridgeArn' => '<string>', // REQUIRED
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
'SourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update.
- FlowSource
-
- Type: UpdateBridgeFlowSourceRequest structure
The name of the flow that you want to update.
- NetworkSource
-
- Type: UpdateBridgeNetworkSourceRequest structure
The network for the bridge source.
- SourceName
-
- Required: Yes
- Type: string
The name of the source that you want to update.
Result Syntax
[
'BridgeArn' => '<string>',
'Source' => [
'FlowSource' => [
'FlowArn' => '<string>',
'FlowVpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
'Name' => '<string>',
'OutputArn' => '<string>',
],
'NetworkSource' => [
'MulticastIp' => '<string>',
'MulticastSourceSettings' => [
'MulticastSourceIp' => '<string>',
],
'Name' => '<string>',
'NetworkName' => '<string>',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
],
],
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the updated bridge source.
- Source
-
- Type: BridgeSource structure
The updated bridge source.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateBridgeState
$result = $client->updateBridgeState([/* ... */]); $promise = $client->updateBridgeStateAsync([/* ... */]);
Updates the bridge state.
Parameter Syntax
$result = $client->updateBridgeState([
'BridgeArn' => '<string>', // REQUIRED
'DesiredState' => 'ACTIVE|STANDBY|DELETED', // REQUIRED
]);
Parameter Details
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bridge that you want to update the state of.
- DesiredState
-
- Required: Yes
- Type: string
The desired state for the bridge.
Result Syntax
[
'BridgeArn' => '<string>',
'DesiredState' => 'ACTIVE|STANDBY|DELETED',
]
Result Details
Members
- BridgeArn
-
- Type: string
The ARN of the updated bridge.
- DesiredState
-
- Type: string
The new state of the bridge.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateFlow
$result = $client->updateFlow([/* ... */]); $promise = $client->updateFlowAsync([/* ... */]);
Updates an existing flow.
Parameter Syntax
$result = $client->updateFlow([
'FlowArn' => '<string>', // REQUIRED
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartHour' => '<string>',
],
'NdiConfig' => [
'MachineName' => '<string>',
'NdiDiscoveryServers' => [
[
'DiscoveryServerAddress' => '<string>', // REQUIRED
'DiscoveryServerPort' => <integer>,
'VpcInterfaceAdapter' => '<string>', // REQUIRED
],
// ...
],
'NdiState' => 'ENABLED|DISABLED',
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'SourceMonitoringConfig' => [
'AudioMonitoringSettings' => [
[
'SilentAudio' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
'ContentQualityAnalysisState' => 'ENABLED|DISABLED',
'ThumbnailState' => 'ENABLED|DISABLED',
'VideoMonitoringSettings' => [
[
'BlackFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
'FrozenFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
],
]);
Parameter Details
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow that you want to update.
- Maintenance
-
- Type: UpdateMaintenance structure
The maintenance setting of the flow.
- NdiConfig
-
- Type: NdiConfig structure
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
- SourceFailoverConfig
-
- Type: UpdateFailoverConfig structure
The settings for source failover.
- SourceMonitoringConfig
-
- Type: MonitoringConfig structure
The settings for source monitoring.
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>',
'FlowSize' => 'MEDIUM|LARGE',
'Maintenance' => [
'MaintenanceDay' => 'Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartHour' => '<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>',
'NdiConfig' => [
'MachineName' => '<string>',
'NdiDiscoveryServers' => [
[
'DiscoveryServerAddress' => '<string>',
'DiscoveryServerPort' => <integer>,
'VpcInterfaceAdapter' => '<string>',
],
// ...
],
'NdiState' => 'ENABLED|DISABLED',
],
'Outputs' => [
[
'BridgeArn' => '<string>',
'BridgePorts' => [<integer>, ...],
'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>',
'OutputStatus' => 'ENABLED|DISABLED',
'PeerIpAddress' => '<string>',
'Port' => <integer>,
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
],
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
'SourceFailoverConfig' => [
'FailoverMode' => 'MERGE|FAILOVER',
'RecoveryWindow' => <integer>,
'SourcePriority' => [
'PrimarySource' => '<string>',
],
'State' => 'ENABLED|DISABLED',
],
'SourceMonitoringConfig' => [
'AudioMonitoringSettings' => [
[
'SilentAudio' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
'ContentQualityAnalysisState' => 'ENABLED|DISABLED',
'ThumbnailState' => 'ENABLED|DISABLED',
'VideoMonitoringSettings' => [
[
'BlackFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
'FrozenFrames' => [
'State' => 'ENABLED|DISABLED',
'ThresholdSeconds' => <integer>,
],
],
// ...
],
],
'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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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 updated flow.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateFlowEntitlement
$result = $client->updateFlowEntitlement([/* ... */]); $promise = $client->updateFlowEntitlementAsync([/* ... */]);
Updates an entitlement. 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 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. Allowable encryption types: static-key, speke.
- EntitlementArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the entitlement that you want to update.
- 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
entitlementStatusfield in your request, MediaConnect leaves the value unchanged. - FlowArn
-
- Required: Yes
- Type: string
The ARN of the flow that is associated with the entitlement that you want to update.
- Subscribers
-
- Type: Array of strings
The Amazon Web Services 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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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 for the stream. This value in measured in kHz.
- Description
-
- Type: string
A description that can help you quickly identify what your media stream is used for.
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.
- MediaStreamName
-
- Required: Yes
- Type: string
The media stream that you updated.
- 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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'OutputArn' => '<string>', // REQUIRED
'OutputStatus' => 'ENABLED|DISABLED',
'Port' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<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 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
keyTypeis provided, the service will use the default setting (static-key). Allowable encryption types: static-key. - FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow that is associated with the output that you want to update.
- MaxLatency
-
- Type: int
The maximum latency in milliseconds. This parameter applies only to RIST-based and 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.
- NdiProgramName
-
- Type: string
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
- NdiSpeedHqQuality
-
- Type: int
A quality setting for the NDI Speed HQ encoder.
- OutputArn
-
- Required: Yes
- Type: string
The ARN of the output that you want to update.
- OutputStatus
-
- Type: string
An indication of whether the output should transmit data or not. If you don't specify the
outputStatusfield in your request, MediaConnect leaves the value unchanged. - Port
-
- Type: int
The port to use when content is distributed to this output.
- Protocol
-
- Type: string
The protocol to use for the output.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- RemoteId
-
- Type: string
The remote ID for the Zixi-pull stream.
- SenderControlPort
-
- Type: int
The port that the flow uses to send outbound requests to initiate connection with the sender.
- SenderIpAddress
-
- Type: string
The IP address that the flow communicates with to initiate connection with the sender.
- 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 and SRT caller-based streams.
- VpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this output.
Result Syntax
[
'FlowArn' => '<string>',
'Output' => [
'BridgeArn' => '<string>',
'BridgePorts' => [<integer>, ...],
'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>',
'OutputStatus' => 'ENABLED|DISABLED',
'PeerIpAddress' => '<string>',
'Port' => <integer>,
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <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:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
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
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<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>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>', // REQUIRED
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
]);
Parameter Details
Members
- Decryption
-
- Type: UpdateEncryption structure
The type of encryption that is used on the content ingested from the source.
- Description
-
- Type: string
A description of the source. This description is not visible outside of the current Amazon Web Services account.
- EntitlementArn
-
- Type: string
The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.
- FlowArn
-
- Required: Yes
- Type: string
The ARN of the flow that you want to update.
- GatewayBridgeSource
-
- Type: UpdateGatewayBridgeSourceRequest structure
The source configuration for cloud flows receiving a stream from a bridge.
- IngestPort
-
- Type: int
The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.
- MaxBitrate
-
- Type: int
The maximum 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 stream that is associated with the source, and the parameters for that association.
- 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.
- Protocol
-
- Type: string
The protocol that the source uses to deliver the content to MediaConnect.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- SenderControlPort
-
- Type: int
The port that the flow uses to send outbound requests to initiate connection with the sender.
- SenderIpAddress
-
- Type: string
The IP address that the flow communicates with to initiate connection with the sender.
- SourceArn
-
- Required: Yes
- Type: string
The ARN of the source that you want to update.
- SourceListenerAddress
-
- Type: string
The source IP or domain name for SRT-caller protocol.
- SourceListenerPort
-
- Type: int
Source port for SRT-caller protocol.
- StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
- VpcInterfaceName
-
- Type: string
The name of the VPC interface that you want to send your output to.
- WhitelistCidr
-
- Type: string
The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as 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>',
'GatewayBridgeSource' => [
'BridgeArn' => '<string>',
'VpcInterfaceAttachment' => [
'VpcInterfaceName' => '<string>',
],
],
'IngestIp' => '<string>',
'IngestPort' => <integer>,
'MediaStreamSourceConfigurations' => [
[
'EncodingName' => 'jxsv|raw|smpte291|pcm',
'InputConfigurations' => [
[
'InputIp' => '<string>',
'InputPort' => <integer>,
'Interface' => [
'Name' => '<string>',
],
],
// ...
],
'MediaStreamName' => '<string>',
],
// ...
],
'Name' => '<string>',
'PeerIpAddress' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SourceArn' => '<string>',
'Transport' => [
'CidrAllowList' => ['<string>', ...],
'MaxBitrate' => <integer>,
'MaxLatency' => <integer>,
'MaxSyncBuffer' => <integer>,
'MinLatency' => <integer>,
'NdiProgramName' => '<string>',
'NdiSpeedHqQuality' => <integer>,
'Protocol' => 'zixi-push|rtp-fec|rtp|zixi-pull|rist|st2110-jpegxs|cdi|srt-listener|srt-caller|fujitsu-qos|udp|ndi-speed-hq',
'RemoteId' => '<string>',
'SenderControlPort' => <integer>,
'SenderIpAddress' => '<string>',
'SmoothingLatency' => <integer>,
'SourceListenerAddress' => '<string>',
'SourceListenerPort' => <integer>,
'StreamId' => '<string>',
],
'VpcInterfaceName' => '<string>',
'WhitelistCidr' => '<string>',
],
]
Result Details
Members
- FlowArn
-
- Type: string
The ARN of the flow that you was updated.
- Source
-
- Type: Source structure
The details of the sources that are assigned to the flow.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
UpdateGatewayInstance
$result = $client->updateGatewayInstance([/* ... */]); $promise = $client->updateGatewayInstanceAsync([/* ... */]);
Updates an existing gateway instance.
Parameter Syntax
$result = $client->updateGatewayInstance([
'BridgePlacement' => 'AVAILABLE|LOCKED',
'GatewayInstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BridgePlacement
-
- Type: string
The state of the instance.
ACTIVEorINACTIVE. - GatewayInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway instance that you want to update.
Result Syntax
[
'BridgePlacement' => 'AVAILABLE|LOCKED',
'GatewayInstanceArn' => '<string>',
]
Result Details
Members
- BridgePlacement
-
- Type: string
The state of the instance.
ACTIVEorINACTIVE. - GatewayInstanceArn
-
- Type: string
The ARN of the instance that was updated.
Errors
- BadRequestException:
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
- TooManyRequestsException:
The request was denied due to request throttling.
- ConflictException:
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ForbiddenException:
You do not have sufficient access to perform this action.
- InternalServerErrorException:
The server encountered an internal error and is unable to complete the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException:
The service is currently unavailable or busy.
Shapes
AddBridgeFlowSourceRequest
Description
Add a flow source to an existing bridge.
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) of the flow to use as a source of this bridge.
- FlowVpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this source.
- Name
-
- Required: Yes
- Type: string
The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
AddBridgeNetworkOutputRequest
Description
Add a network output to an existing bridge.
Members
- IpAddress
-
- Required: Yes
- Type: string
The network output IP Address.
- Name
-
- Required: Yes
- Type: string
The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
- NetworkName
-
- Required: Yes
- Type: string
The network output's gateway network name.
- Port
-
- Required: Yes
- Type: int
The network output port.
- Protocol
-
- Required: Yes
- Type: string
The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- Ttl
-
- Required: Yes
- Type: int
The network output TTL.
AddBridgeNetworkSourceRequest
Description
Add a network source to an existing bridge.
Members
- MulticastIp
-
- Required: Yes
- Type: string
The network source multicast IP.
- MulticastSourceSettings
-
- Type: MulticastSourceSettings structure
The settings related to the multicast source.
- Name
-
- Required: Yes
- Type: string
The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
- NetworkName
-
- Required: Yes
- Type: string
The network source's gateway network name.
- Port
-
- Required: Yes
- Type: int
The network source port.
- Protocol
-
- Required: Yes
- Type: string
The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
AddBridgeOutputRequest
Description
Add outputs to the specified bridge.
Members
- NetworkOutput
-
- Type: AddBridgeNetworkOutputRequest structure
The network output of the bridge. A network output is delivered to your premises.
AddBridgeSourceRequest
Description
Add an output to a bridge.
Members
- FlowSource
-
- Type: AddBridgeFlowSourceRequest structure
The source of the flow.
- NetworkSource
-
- Type: AddBridgeNetworkSourceRequest structure
The source of the network.
AddEgressGatewayBridgeRequest
Description
Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
Members
- MaxBitrate
-
- Required: Yes
- Type: int
The maximum expected bitrate (in bps) of the egress bridge.
AddFlowOutputs420Exception
Description
Exception raised by Elemental MediaConnect when adding the flow output. See the error message for the operation for more information on the cause of this exception.
Members
- Message
-
- Required: Yes
- Type: string
AddIngressGatewayBridgeRequest
Description
Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
Members
- MaxBitrate
-
- Required: Yes
- Type: int
The maximum expected bitrate (in bps) of the ingress bridge.
- MaxOutputs
-
- Required: Yes
- Type: int
The maximum number of expected outputs on the ingress bridge.
AddMaintenance
Description
Create a maintenance setting for a flow.
Members
- MaintenanceDay
-
- Required: Yes
- Type: string
A day of a week when the maintenance will happen.
- MaintenanceStartHour
-
- Required: Yes
- Type: string
UTC time when the maintenance will happen.
Use 24-hour HH:MM format.
Minutes must be 00.
Example: 13:00.
The default value is 02:00.
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
A request to add an output to a flow.
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 Audit Manager 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). Allowable encryption types: static-key.
- MaxLatency
-
- Type: int
The maximum latency in milliseconds. This parameter applies only to RIST-based and 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.
- Name
-
- Type: string
The name of the output. This value must be unique within the current flow.
- NdiProgramName
-
- Type: string
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
- NdiSpeedHqQuality
-
- Type: int
A quality setting for the NDI Speed HQ encoder.
- OutputStatus
-
- Type: string
An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
- 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.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- RemoteId
-
- Type: string
The remote ID for the Zixi-pull output stream.
- SenderControlPort
-
- Type: int
The port that the flow uses to send outbound requests to initiate connection with the sender.
- 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 and SRT caller-based streams.
- VpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this output.
AudioMonitoringSetting
Description
Specifies the configuration for audio stream metrics monitoring.
Members
- SilentAudio
-
- Type: SilentAudio structure
Detects periods of silence.
BadRequestException
Description
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
Members
- Message
-
- Required: Yes
- Type: string
BlackFrames
Description
Configures settings for the BlackFrames metric.
Members
- State
-
- Type: string
Indicates whether the
BlackFramesmetric is enabled or disabled.. - ThresholdSeconds
-
- Type: int
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
Bridge
Description
A Bridge is the connection between your data center's Instances and the Amazon Web Services cloud. A bridge can be used to send video from the Amazon Web Services cloud to your data center or from your data center to the Amazon Web Services cloud.
Members
- BridgeArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) of the bridge.
- BridgeMessages
-
- Type: Array of MessageDetail structures
Messages with details about the bridge.
- BridgeState
-
- Required: Yes
- Type: string
The state of the bridge.
- EgressGatewayBridge
-
- Type: EgressGatewayBridge structure
An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
- IngressGatewayBridge
-
- Type: IngressGatewayBridge structure
An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
- Name
-
- Required: Yes
- Type: string
The name of the bridge.
- Outputs
-
- Type: Array of BridgeOutput structures
The outputs on this bridge.
- PlacementArn
-
- Required: Yes
- Type: string
The placement Amazon Resource Number (ARN) of the bridge.
- SourceFailoverConfig
-
- Type: FailoverConfig structure
The settings for source failover.
- Sources
-
- Type: Array of BridgeSource structures
The sources on this bridge.
BridgeFlowOutput
Description
The output of the bridge. A flow output is delivered to the Amazon Web Services cloud.
Members
- FlowArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) of the cloud flow.
- FlowSourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) of the flow source.
- Name
-
- Required: Yes
- Type: string
The name of the bridge's output.
BridgeFlowSource
Description
The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
Members
- FlowArn
-
- Required: Yes
- Type: string
The ARN of the cloud flow used as a source of this bridge.
- FlowVpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this source.
- Name
-
- Required: Yes
- Type: string
The name of the flow source.
- OutputArn
-
- Type: string
The Amazon Resource Number (ARN) of the output.
BridgeNetworkOutput
Description
The output of the bridge. A network output is delivered to your premises.
Members
- IpAddress
-
- Required: Yes
- Type: string
The network output IP address.
- Name
-
- Required: Yes
- Type: string
The network output name.
- NetworkName
-
- Required: Yes
- Type: string
The network output's gateway network name.
- Port
-
- Required: Yes
- Type: int
The network output's port.
- Protocol
-
- Required: Yes
- Type: string
The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- Ttl
-
- Required: Yes
- Type: int
The network output TTL.
BridgeNetworkSource
Description
The source of the bridge. A network source originates at your premises.
Members
- MulticastIp
-
- Required: Yes
- Type: string
The network source multicast IP.
- MulticastSourceSettings
-
- Type: MulticastSourceSettings structure
The settings related to the multicast source.
- Name
-
- Required: Yes
- Type: string
The name of the network source.
- NetworkName
-
- Required: Yes
- Type: string
The network source's gateway network name.
- Port
-
- Required: Yes
- Type: int
The network source port.
- Protocol
-
- Required: Yes
- Type: string
The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
BridgeOutput
Description
The output of the bridge.
Members
- FlowOutput
-
- Type: BridgeFlowOutput structure
The output of the associated flow.
- NetworkOutput
-
- Type: BridgeNetworkOutput structure
The network output for the bridge.
BridgeSource
Description
The bridge's source.
Members
- FlowSource
-
- Type: BridgeFlowSource structure
The source of the associated flow.
- NetworkSource
-
- Type: BridgeNetworkSource structure
The network source for the bridge.
ConflictException
Description
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
Members
- Message
-
- Required: Yes
- Type: string
CreateBridge420Exception
Description
Exception raised by Elemental MediaConnect when creating the bridge. See the error message for the operation for more information on the cause of this exception.
Members
- Message
-
- Required: Yes
- Type: string
CreateFlow420Exception
Description
Exception raised by Elemental MediaConnect when creating the flow. See the error message for the operation for more information on the cause of this exception.
Members
- Message
-
- Required: Yes
- Type: string
CreateGateway420Exception
Description
Exception raised by Elemental MediaConnect when creating the gateway. See the error message for the operation for more information on the cause of this exception.
Members
- Message
-
- Required: Yes
- Type: string
DestinationConfiguration
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: Interface structure
The VPC interface that you want to use 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 or protocol.
DestinationConfigurationRequest
Description
The definition of a media stream that you want to associate with the output.
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.
EgressGatewayBridge
Description
Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
Members
- InstanceId
-
- Type: string
The ID of the instance running this bridge.
- MaxBitrate
-
- Required: Yes
- Type: int
The maximum expected bitrate (in bps) of the egress bridge.
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
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, 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 Amazon Web Services 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 MediaConnect as a trusted entity).
- SecretArn
-
- Type: string
The ARN of the secret that you created in 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 Amazon Web Services 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
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
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 Amazon Web Services Region.
- Description
-
- Type: string
A description of the flow. This value is not used or seen outside of the current 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) of the flow.
- FlowSize
-
- Type: string
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
- Maintenance
-
- Type: Maintenance structure
The maintenance settings for 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.
- NdiConfig
-
- Type: NdiConfig structure
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
- Outputs
-
- Required: Yes
- Type: Array of Output structures
The outputs in this flow.
- Source
-
- Required: Yes
- Type: Source structure
The source for the flow.
- SourceFailoverConfig
-
- Type: FailoverConfig structure
The settings for the source failover.
- SourceMonitoringConfig
-
- Type: MonitoringConfig structure
The settings for source monitoring.
- Sources
-
- Type: Array of Source structures
The settings for the sources that are assigned to the flow.
- 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
A set of parameters that define the media stream.
Members
- ChannelOrder
-
- Type: string
The format of the audio channel.
- Colorimetry
-
- Type: string
The format used for the representation of color.
- ExactFramerate
-
- Type: string
The frame rate for the video stream, in frames/second. For example: 60000/1001.
- 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
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.
ForbiddenException
Description
You do not have sufficient access to perform this action.
Members
- Message
-
- Required: Yes
- Type: string
FrameResolution
Description
The frame resolution used by the video stream.
Members
- FrameHeight
-
- Required: Yes
- Type: int
The number of pixels in the height of the video frame.
- FrameWidth
-
- Required: Yes
- Type: int
The number of pixels in the width of the video frame.
FrozenFrames
Description
Configures settings for the FrozenFrames metric.
Members
- State
-
- Type: string
Indicates whether the
FrozenFramesmetric is enabled or disabled. - ThresholdSeconds
-
- Type: int
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
Gateway
Description
The settings for a gateway, including its networks.
Members
- EgressCidrBlocks
-
- Required: Yes
- Type: Array of strings
The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
- GatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway.
- GatewayMessages
-
- Type: Array of MessageDetail structures
Messages with information about the gateway.
- GatewayState
-
- Type: string
The current status of the gateway.
- Name
-
- Required: Yes
- Type: string
The name of the gateway. This name can not be modified after the gateway is created.
- Networks
-
- Required: Yes
- Type: Array of GatewayNetwork structures
The list of networks in the gateway.
GatewayBridgeSource
Description
The source configuration for cloud flows receiving a stream from a bridge.
Members
- BridgeArn
-
- Required: Yes
- Type: string
The ARN of the bridge feeding this flow.
- VpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this bridge source.
GatewayInstance
Description
The settings for an instance in a gateway.
Members
- BridgePlacement
-
- Required: Yes
- Type: string
The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
- ConnectionStatus
-
- Required: Yes
- Type: string
The connection state of the instance.
- GatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the instance.
- GatewayInstanceArn
-
- Required: Yes
- Type: string
The ARN of the gateway.
- InstanceId
-
- Required: Yes
- Type: string
The instance ID generated by the SSM install. This will begin with "mi-".
- InstanceMessages
-
- Type: Array of MessageDetail structures
Messages with information about the gateway.
- InstanceState
-
- Required: Yes
- Type: string
The status of the instance.
- RunningBridgeCount
-
- Required: Yes
- Type: int
The running bridge count.
GatewayNetwork
Description
The network settings for a gateway.
Members
- CidrBlock
-
- Required: Yes
- Type: string
A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
- Name
-
- Required: Yes
- Type: string
The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
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 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. Allowable encryption types: static-key, speke.
- 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 Amazon Web Services 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 Elemental MediaConnect when granting the entitlement. See the error message for the operation for more information on the cause of this exception.
Members
- Message
-
- Required: Yes
- Type: string
IngressGatewayBridge
Description
Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
Members
- InstanceId
-
- Type: string
The ID of the instance running this bridge.
- MaxBitrate
-
- Required: Yes
- Type: int
The maximum expected bitrate (in bps) of the ingress bridge.
- MaxOutputs
-
- Required: Yes
- Type: int
The maximum number of outputs on the ingress bridge.
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
The server encountered an internal error and is unable to complete the request.
Members
- Message
-
- Required: Yes
- Type: string
ListedBridge
Description
Displays details of the selected bridge.
Members
- BridgeArn
-
- Required: Yes
- Type: string
The ARN of the bridge.
- BridgeState
-
- Required: Yes
- Type: string
The state of the bridge.
- BridgeType
-
- Required: Yes
- Type: string
The type of the bridge.
- Name
-
- Required: Yes
- Type: string
The name of the bridge.
- PlacementArn
-
- Required: Yes
- Type: string
The ARN of the gateway associated with the bridge.
ListedEntitlement
Description
An entitlement that has been granted to you from other Amazon Web Services 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
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.
- Maintenance
-
- Type: Maintenance structure
The maintenance settings for 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 MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account).
- Status
-
- Required: Yes
- Type: string
The current status of the flow.
ListedGateway
Description
A summary of a gateway, including its name, ARN, and status.
Members
- GatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway.
- GatewayState
-
- Required: Yes
- Type: string
The status of the gateway.
- Name
-
- Required: Yes
- Type: string
The name of the gateway.
ListedGatewayInstance
Description
A summary of an instance.
Members
- GatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gateway.
- GatewayInstanceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the instance.
- InstanceId
-
- Required: Yes
- Type: string
The managed instance ID generated by the SSM install. This will begin with "mi-".
- InstanceState
-
- Type: string
The status of the instance.
Maintenance
Description
The maintenance setting of a flow.
Members
- MaintenanceDay
-
- Type: string
A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
- MaintenanceDeadline
-
- Type: string
The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
- MaintenanceScheduledDate
-
- Type: string
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
- MaintenanceStartHour
-
- Type: string
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
MediaStream
Description
A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
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
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.
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
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.
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 media streams that you want to associate with the output.
- 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
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.
- InputConfigurations
-
- Type: Array of InputConfiguration structures
The media streams that you want to associate with the source.
- MediaStreamName
-
- Required: Yes
- Type: string
A name that helps you distinguish one media stream from another.
MediaStreamSourceConfigurationRequest
Description
The media stream that you want to associate with the source, and the parameters for that association.
Members
- 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.
- InputConfigurations
-
- Type: Array of InputConfigurationRequest structures
The media streams that you want to associate with the source.
- MediaStreamName
-
- Required: Yes
- Type: string
The name of the media stream.
MessageDetail
Description
The details of an error message.
Members
- Code
-
- Required: Yes
- Type: string
The error code.
- Message
-
- Required: Yes
- Type: string
The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
- ResourceName
-
- Type: string
The name of the resource.
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.
MonitoringConfig
Description
The settings for source monitoring.
Members
- AudioMonitoringSettings
-
- Type: Array of AudioMonitoringSetting structures
Contains the settings for audio stream metrics monitoring.
- ContentQualityAnalysisState
-
- Type: string
Indicates whether content quality analysis is enabled or disabled.
- ThumbnailState
-
- Type: string
Indicates whether thumbnails are enabled or disabled.
- VideoMonitoringSettings
-
- Type: Array of VideoMonitoringSetting structures
Contains the settings for video stream metrics monitoring.
MulticastSourceSettings
Description
The settings related to the multicast source.
Members
- MulticastSourceIp
-
- Type: string
The IP address of the source for source-specific multicast (SSM).
NdiConfig
Description
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Members
- MachineName
-
- Type: string
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
- NdiDiscoveryServers
-
- Type: Array of NdiDiscoveryServerConfig structures
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
- NdiState
-
- Type: string
A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
NdiDiscoveryServerConfig
Description
Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.
Members
- DiscoveryServerAddress
-
- Required: Yes
- Type: string
The unique network address of the NDI discovery server.
- DiscoveryServerPort
-
- Type: int
The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
- VpcInterfaceAdapter
-
- Required: Yes
- Type: string
The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
NotFoundException
Description
One or more of the resources in the request does not exist in the system.
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
- BridgeArn
-
- Type: string
The ARN of the bridge added to this output.
- BridgePorts
-
- Type: Array of ints
The bridge output ports currently in use.
- 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 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.
- OutputStatus
-
- Type: string
An indication of whether the output is transmitting data or not.
- PeerIpAddress
-
- Type: string
The IP address of the device that is currently receiving content from this output.
-
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
-
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
-
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
- 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
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.
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.
ServiceUnavailableException
Description
The service is currently unavailable or busy.
Members
- Message
-
- Required: Yes
- Type: string
SetGatewayBridgeSourceRequest
Description
The source configuration for cloud flows receiving a stream from a bridge.
Members
- BridgeArn
-
- Required: Yes
- Type: string
The ARN of the bridge feeding this flow.
- VpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this bridge source.
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. Allowable encryption types: static-key.
- Description
-
- Type: string
A description for the source. This value is not used or seen outside of the current 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.
- GatewayBridgeSource
-
- Type: SetGatewayBridgeSourceRequest structure
The source configuration for cloud flows receiving a stream from a bridge.
- IngestPort
-
- Type: int
The port that the flow will be listening on for incoming content.
- MaxBitrate
-
- Type: int
The smoothing max bitrate (in bps) 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
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.
- Name
-
- Type: string
The name of the source.
- Protocol
-
- Type: string
The protocol that is used by the source.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- SenderControlPort
-
- Type: int
The port that the flow uses to send outbound requests to initiate connection with the sender.
- SenderIpAddress
-
- Type: string
The IP address that the flow communicates with to initiate connection with the sender.
- SourceListenerAddress
-
- Type: string
Source IP or domain name for SRT-caller protocol.
- SourceListenerPort
-
- Type: int
Source port for SRT-caller protocol.
- StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-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.
SilentAudio
Description
Configures settings for the SilentAudio metric.
Members
- State
-
- Type: string
Indicates whether the
SilentAudiometric is enabled or disabled. - ThresholdSeconds
-
- Type: int
Specifies the number of consecutive seconds of silence that triggers an event or alert.
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 MediaConnect account.
- EntitlementArn
-
- Type: string
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
- GatewayBridgeSource
-
- Type: GatewayBridgeSource structure
The source configuration for cloud flows receiving a stream from a bridge.
- 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.
- PeerIpAddress
-
- Type: string
The IP address of the device that is currently sending content to this source.
-
For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.
-
For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.
-
Peer IP addresses aren't available for entitlements and CDI/ST2110 sources.
-
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
- SenderControlPort
-
- Type: int
The IP address that the flow communicates with to initiate connection with the sender.
- SenderIpAddress
-
- Type: string
The port that the flow uses to send outbound requests to initiate connection with the sender.
- 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
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.
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.
ThumbnailDetails
Description
The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated.
Members
- FlowArn
-
- Required: Yes
- Type: string
The ARN of the flow that DescribeFlowSourceThumbnail was performed on.
- Thumbnail
-
- Type: string
Thumbnail Base64 string.
- ThumbnailMessages
-
- Required: Yes
- Type: Array of MessageDetail structures
Status code and messages about the flow source thumbnail.
- Timecode
-
- Type: string
Timecode of thumbnail.
- Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when thumbnail was generated.
TooManyRequestsException
Description
The request was denied due to request throttling.
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
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
- MaxBitrate
-
- Type: int
The smoothing max bitrate (in bps) 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
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.
- NdiProgramName
-
- Type: string
A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
- NdiSpeedHqQuality
-
- Type: int
A quality setting for the NDI Speed HQ encoder.
- Protocol
-
- Required: Yes
- Type: string
The protocol that is used by the source or output.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- RemoteId
-
- Type: string
The remote ID for the Zixi-pull stream.
- SenderControlPort
-
- Type: int
The port that the flow uses to send outbound requests to initiate connection with the sender.
- SenderIpAddress
-
- Type: string
The IP address that the flow communicates with to initiate connection with the sender.
- SmoothingLatency
-
- Type: int
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
- SourceListenerAddress
-
- Type: string
Source IP or domain name for SRT-caller protocol.
- SourceListenerPort
-
- Type: int
Source port for SRT-caller protocol.
- StreamId
-
- Type: string
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
TransportMediaInfo
Description
The metadata of the transport stream in the current flow's source.
Members
- Programs
-
- Required: Yes
- Type: Array of TransportStreamProgram structures
The list of transport stream programs in the current flow's source.
TransportStream
Description
The metadata of an elementary transport stream.
Members
- Channels
-
- Type: int
The number of channels in the audio stream.
- Codec
-
- Type: string
The codec used by the stream.
- FrameRate
-
- Type: string
The frame rate used by the video stream.
- FrameResolution
-
- Type: FrameResolution structure
The frame resolution used by the video stream.
- Pid
-
- Required: Yes
- Type: int
The Packet ID (PID) as it is reported in the Program Map Table.
- SampleRate
-
- Type: int
The sample rate used by the audio stream.
- SampleSize
-
- Type: int
The sample bit size used by the audio stream.
- StreamType
-
- Required: Yes
- Type: string
The Stream Type as it is reported in the Program Map Table.
TransportStreamProgram
Description
The metadata of a single transport stream program.
Members
- PcrPid
-
- Required: Yes
- Type: int
The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.
- ProgramName
-
- Type: string
The program name as it is reported in the Program Association Table.
- ProgramNumber
-
- Required: Yes
- Type: int
The program number as it is reported in the Program Association Table.
- ProgramPid
-
- Required: Yes
- Type: int
The program Packet ID (PID) as it is reported in the Program Association Table.
- Streams
-
- Required: Yes
- Type: Array of TransportStream structures
The list of elementary transport streams in the program. The list includes video, audio, and data streams.
UpdateBridgeFlowSourceRequest
Description
Update the flow source of the bridge.
Members
- FlowArn
-
- Type: string
The Amazon Resource Name (ARN) that identifies the MediaConnect resource from which to delete tags.
- FlowVpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this source.
UpdateBridgeNetworkOutputRequest
Description
Update an existing network output.
Members
- IpAddress
-
- Type: string
The network output IP Address.
- NetworkName
-
- Type: string
The network output's gateway network name.
- Port
-
- Type: int
The network output port.
- Protocol
-
- Type: string
The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
- Ttl
-
- Type: int
The network output TTL.
UpdateBridgeNetworkSourceRequest
Description
Update the network source of the bridge.
Members
- MulticastIp
-
- Type: string
The network source multicast IP.
- MulticastSourceSettings
-
- Type: MulticastSourceSettings structure
The settings related to the multicast source.
- NetworkName
-
- Type: string
The network source's gateway network name.
- Port
-
- Type: int
The network source port.
- Protocol
-
- Type: string
The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
UpdateEgressGatewayBridgeRequest
Description
Update an existing egress-type bridge.
Members
- MaxBitrate
-
- Type: int
The maximum expected bitrate (in bps).
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
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 Amazon Web Services 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
-
- Type: string
The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
- SecretArn
-
- Type: string
The ARN of the secret that you created in 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
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
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
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
UpdateGatewayBridgeSourceRequest
Description
The source configuration for cloud flows receiving a stream from a bridge.
Members
- BridgeArn
-
- Type: string
The ARN of the bridge feeding this flow.
- VpcInterfaceAttachment
-
- Type: VpcInterfaceAttachment structure
The name of the VPC interface attachment to use for this bridge source.
UpdateIngressGatewayBridgeRequest
Description
Update an existing ingress-type bridge.
Members
- MaxBitrate
-
- Type: int
The maximum expected bitrate (in bps).
- MaxOutputs
-
- Type: int
The maximum number of expected outputs.
UpdateMaintenance
Description
Update maintenance setting for a flow.
Members
- MaintenanceDay
-
- Type: string
A day of a week when the maintenance will happen.
- MaintenanceScheduledDate
-
- Type: string
A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
- MaintenanceStartHour
-
- Type: string
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
VideoMonitoringSetting
Description
Specifies the configuration for video stream metrics monitoring.
Members
- BlackFrames
-
- Type: BlackFrames structure
Detects video frames that are black.
- FrozenFrames
-
- Type: FrozenFrames structure
Detects video frames that have not changed.
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
A role Arn MediaConnect can assume to create ENIs in your 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 resource.
Members
- VpcInterfaceName
-
- Type: string
The name of the VPC interface to use for this resource.
VpcInterfaceRequest
Description
The details of the VPC interfaces that you want to add to the flow.
Members
- Name
-
- Required: Yes
- Type: string
The name for the VPC interface. This name must be unique within the flow.
- NetworkInterfaceType
-
- Type: string
The type of network interface.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A virtual firewall to control inbound and outbound traffic.
- SubnetId
-
- Required: Yes
- Type: string
The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.