2020/03/18 - AWS MediaConnect - 3 new 2 updated api methods
Changes Feature adds the ability for a flow to have multiple redundant sources that provides resiliency to a source failing. The new APIs added to enable the feature are, AddFlowSources, RemoveFlowSource and UpdateFlow.
Adds Sources to flow
See also: AWS API Documentation
Request Syntax
client.add_flow_sources(
FlowArn='string',
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'StreamId': 'string',
'WhitelistCidr': 'string'
},
]
)
string
[REQUIRED] The flow that you want to mutate.
list
[REQUIRED] A list of sources that you want to add.
(dict) -- The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- [REQUIRED] The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
dict
Response Syntax
{
'FlowArn': 'string',
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
]
}
Response Structure
(dict) -- AWS Elemental MediaConnect added sources to the flow successfully.
FlowArn (string) -- The ARN of the flow that these sources were added to.
Sources (list) -- The details of the newly added sources.
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
Updates flow
See also: AWS API Documentation
Request Syntax
client.update_flow(
FlowArn='string',
SourceFailoverConfig={
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
}
)
string
[REQUIRED] The flow that you want to update.
dict
The settings for source failover
RecoveryWindow (integer) -- Recovery window time to look for dash-7 packets
State (string) --
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
'SourceFailoverConfig': {
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect updated the flow successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
SourceFailoverConfig (dict) -- The settings for source failover
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
Status (string) -- The current status of the flow.
Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
See also: AWS API Documentation
Request Syntax
client.remove_flow_source(
FlowArn='string',
SourceArn='string'
)
string
[REQUIRED] The flow that you want to remove a source from.
string
[REQUIRED] The ARN of the source that you want to remove.
dict
Response Syntax
{
'FlowArn': 'string',
'SourceArn': 'string'
}
Response Structure
(dict) -- source successfully removed from flow configuration.
FlowArn (string) -- The ARN of the flow that is associated with the source you removed.
SourceArn (string) -- The ARN of the source that was removed.
{'SourceFailoverConfig': {'RecoveryWindow': 'integer',
'State': 'ENABLED | DISABLED'},
'Sources': [{'Decryption': {'Algorithm': 'aes128 | aes192 | aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke | static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 'integer',
'MaxBitrate': 'integer',
'MaxLatency': 'integer',
'Name': 'string',
'Protocol': 'zixi-push | rtp-fec | rtp | zixi-pull | rist',
'StreamId': 'string',
'WhitelistCidr': 'string'}]}
Response {'Flow': {'SourceFailoverConfig': {'RecoveryWindow': 'integer',
'State': 'ENABLED | DISABLED'},
'Sources': [{'DataTransferSubscriberFeePercent': 'integer',
'Decryption': {'Algorithm': 'aes128 | aes192 | aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke | static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 'integer',
'Name': 'string',
'SourceArn': 'string',
'Transport': {'CidrAllowList': ['string'],
'MaxBitrate': 'integer',
'MaxLatency': 'integer',
'Protocol': 'zixi-push | rtp-fec | rtp | '
'zixi-pull | rist',
'RemoteId': 'string',
'SmoothingLatency': 'integer',
'StreamId': 'string'},
'WhitelistCidr': 'string'}]}}
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
See also: AWS API Documentation
Request Syntax
client.create_flow(
AvailabilityZone='string',
Entitlements=[
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Name': 'string',
'Subscribers': [
'string',
]
},
],
Name='string',
Outputs=[
{
'CidrAllowList': [
'string',
],
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
],
Source={
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'StreamId': 'string',
'WhitelistCidr': 'string'
},
SourceFailoverConfig={
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
},
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'StreamId': 'string',
'WhitelistCidr': 'string'
},
]
)
string
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
list
The entitlements that you want to grant on a flow.
(dict) -- The entitlements that you want to grant on a flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- [REQUIRED] The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Name (string) -- The name of the entitlement. This value must be unique within the current flow.
Subscribers (list) -- [REQUIRED] The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
(string) --
string
[REQUIRED] The name of the flow.
list
The outputs that you want to add to this flow.
(dict) -- The output that you want to add to this flow.
CidrAllowList (list) -- 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.
(string) --
Description (string) -- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
Destination (string) -- The IP address from which video will be sent to output destinations.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- [REQUIRED] The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
MaxLatency (integer) -- The maximum latency in milliseconds for Zixi-based streams.
Name (string) -- The name of the output. This value must be unique within the current flow.
Port (integer) -- The port to use when content is distributed to this output.
Protocol (string) -- [REQUIRED] The protocol to use for the output.
RemoteId (string) -- The remote ID for the Zixi-pull output stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
dict
The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- [REQUIRED] The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
dict
The settings for source failover
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
State (string) --
list
(dict) -- The settings for the source of the flow.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- [REQUIRED] The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- [REQUIRED] The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Name (string) -- The name of the source.
Protocol (string) -- The protocol that is used by the source.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
'SourceFailoverConfig': {
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect created the new flow successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
SourceFailoverConfig (dict) -- The settings for source failover
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
Status (string) -- The current status of the flow.
{'Flow': {'SourceFailoverConfig': {'RecoveryWindow': 'integer',
'State': 'ENABLED | DISABLED'},
'Sources': [{'DataTransferSubscriberFeePercent': 'integer',
'Decryption': {'Algorithm': 'aes128 | aes192 | aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke | static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 'integer',
'Name': 'string',
'SourceArn': 'string',
'Transport': {'CidrAllowList': ['string'],
'MaxBitrate': 'integer',
'MaxLatency': 'integer',
'Protocol': 'zixi-push | rtp-fec | rtp | '
'zixi-pull | rist',
'RemoteId': 'string',
'SmoothingLatency': 'integer',
'StreamId': 'string'},
'WhitelistCidr': 'string'}]}}
Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
See also: AWS API Documentation
Request Syntax
client.describe_flow(
FlowArn='string'
)
string
[REQUIRED] The ARN of the flow that you want to describe.
dict
Response Syntax
{
'Flow': {
'AvailabilityZone': 'string',
'Description': 'string',
'EgressIp': 'string',
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
'FlowArn': 'string',
'Name': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'Description': 'string',
'Destination': 'string',
'Encryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
'SourceFailoverConfig': {
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
},
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
},
'Messages': {
'Errors': [
'string',
]
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect returned the flow details successfully.
Flow (dict) -- The settings for a flow, including its source, outputs, and entitlements.
AvailabilityZone (string) -- The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
Description (string) -- A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EgressIp (string) -- The IP address from which video will be sent to output destinations.
Entitlements (list) -- The entitlements in this flow.
(dict) -- The settings for a flow entitlement.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the entitlement.
Encryption (dict) -- The type of encryption that will be used on the output that is associated with this entitlement.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement.
Name (string) -- The name of the entitlement.
Subscribers (list) -- The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
(string) --
FlowArn (string) -- The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
Name (string) -- The name of the flow.
Outputs (list) -- The outputs in this flow.
(dict) -- The settings for an output.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Description (string) -- A description of the output.
Destination (string) -- The address where you want to send the output.
Encryption (dict) -- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
EntitlementArn (string) -- The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
MediaLiveInputArn (string) -- The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
Name (string) -- The name of the output. This value must be unique within the current flow.
OutputArn (string) -- The ARN of the output.
Port (integer) -- The port to use when content is distributed to this output.
Transport (dict) -- Attributes related to the transport stream that are used in the output.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
Source (dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
SourceFailoverConfig (dict) -- The settings for source failover
RecoveryWindow (integer) -- Search window time to look for dash-7 packets
State (string) --
Sources (list) --
(dict) -- The settings for the source of the flow.
DataTransferSubscriberFeePercent (integer) -- Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
Decryption (dict) -- The type of encryption that is used on the content ingested from this source.
Algorithm (string) -- The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector (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 (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 (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 (string) -- The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId (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 (string) -- The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
SecretArn (string) -- The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url (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.
Description (string) -- A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
EntitlementArn (string) -- The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
IngestIp (string) -- The IP address that the flow will be listening on for incoming content.
IngestPort (integer) -- The port that the flow will be listening on for incoming content.
Name (string) -- The name of the source.
SourceArn (string) -- The ARN of the source.
Transport (dict) -- Attributes related to the transport stream that are used in the source.
CidrAllowList (list) -- 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.
(string) --
MaxBitrate (integer) -- The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency (integer) -- The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
Protocol (string) -- The protocol that is used by the source or output.
RemoteId (string) -- The remote ID for the Zixi-pull stream.
SmoothingLatency (integer) -- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId (string) -- The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
WhitelistCidr (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.
Status (string) -- The current status of the flow.
Messages (dict) -- Messages that provide the state of the flow.
Errors (list) -- A list of errors that might have been generated from processes on this flow.
(string) --