Table of Contents
A low-level client representing AWS MediaConnect API for AWS Elemental MediaConnect:
import boto3
client = boto3.client('mediaconnect')
These are the available methods:
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
See also: AWS API Documentation
Request Syntax
response = client.add_flow_outputs(
FlowArn='string',
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',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string',
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
]
)
[REQUIRED] A list of outputs that you want to add.
dict
Response Syntax
{
'FlowArn': 'string',
'Outputs': [
{
'DataTransferSubscriberFeePercent': 123,
'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',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
]
}
Response Structure
Exceptions
Adds Sources to flow
See also: AWS API Documentation
Request Syntax
response = client.add_flow_sources(
FlowArn='string',
Sources=[
{
'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',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
]
)
[REQUIRED] A list of sources that you want to add.
dict
Response Syntax
{
'FlowArn': 'string',
'Sources': [
{
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
]
}
Response Structure
Exceptions
Adds VPC interfaces to flow
See also: AWS API Documentation
Request Syntax
response = client.add_flow_vpc_interfaces(
FlowArn='string',
VpcInterfaces=[
{
'Name': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
)
[REQUIRED] A list of VPC interfaces that you want to add.
dict
Response Syntax
{
'FlowArn': 'string',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
}
Response Structure
Exceptions
Check if an operation can be paginated.
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
response = client.create_flow(
AvailabilityZone='string',
Entitlements=[
{
'DataTransferSubscriberFeePercent': 123,
'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'
},
'EntitlementStatus': 'ENABLED'|'DISABLED',
'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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'MaxLatency': 123,
'MinLatency': 123,
'Name': 'string',
'Port': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'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',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
SourceFailoverConfig={
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
},
Sources=[
{
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestPort': 123,
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Name': 'string',
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'StreamId': 'string',
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
VpcInterfaces=[
{
'Name': 'string',
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
)
The entitlements that you want to grant on a flow.
The outputs that you want to add to this flow.
The settings for the source of the flow.
The settings for source failover
The VPC interfaces you want on the flow.
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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': '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'|'srt-password',
'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,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
}
}
Response Structure
Exceptions
Deletes a flow. Before you can delete a flow, you must stop the flow.
See also: AWS API Documentation
Request Syntax
response = client.delete_flow(
FlowArn='string'
)
{
'FlowArn': 'string',
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}
Response Structure
Exceptions
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
response = client.describe_flow(
FlowArn='string'
)
{
'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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': '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'|'srt-password',
'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,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
},
'Messages': {
'Errors': [
'string',
]
}
}
Response Structure
Exceptions
Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.describe_offering(
OfferingArn='string'
)
{
'Offering': {
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
}
}
}
Response Structure
Exceptions
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).
See also: AWS API Documentation
Request Syntax
response = client.describe_reservation(
ReservationArn='string'
)
{
'Reservation': {
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
}
}
Response Structure
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Grants entitlements to an existing flow.
See also: AWS API Documentation
Request Syntax
response = client.grant_flow_entitlements(
Entitlements=[
{
'DataTransferSubscriberFeePercent': 123,
'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'
},
'EntitlementStatus': 'ENABLED'|'DISABLED',
'Name': 'string',
'Subscribers': [
'string',
]
},
],
FlowArn='string'
)
[REQUIRED] The list of entitlements that you want to grant.
dict
Response Syntax
{
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'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'
}
Response Structure
Exceptions
Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
See also: AWS API Documentation
Request Syntax
response = client.list_entitlements(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'EntitlementArn': 'string',
'EntitlementName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Displays a list of flows that are associated with this account. This request returns a paginated result.
See also: AWS API Documentation
Request Syntax
response = client.list_flows(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Flows': [
{
'AvailabilityZone': 'string',
'Description': 'string',
'FlowArn': 'string',
'Name': 'string',
'SourceType': 'OWNED'|'ENTITLED',
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.
See also: AWS API Documentation
Request Syntax
response = client.list_offerings(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Offerings': [
{
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
}
},
]
}
Response Structure
Exceptions
Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).
See also: AWS API Documentation
Request Syntax
response = client.list_reservations(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Reservations': [
{
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
},
]
}
Response Structure
Exceptions
List all tags on an AWS Elemental MediaConnect resource
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
{
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
See also: AWS API Documentation
Request Syntax
response = client.purchase_offering(
OfferingArn='string',
ReservationName='string',
Start='string'
)
dict
Response Syntax
{
'Reservation': {
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
}
}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.remove_flow_output(
FlowArn='string',
OutputArn='string'
)
dict
Response Syntax
{
'FlowArn': 'string',
'OutputArn': 'string'
}
Response Structure
Exceptions
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
response = client.remove_flow_source(
FlowArn='string',
SourceArn='string'
)
dict
Response Syntax
{
'FlowArn': 'string',
'SourceArn': 'string'
}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.remove_flow_vpc_interface(
FlowArn='string',
VpcInterfaceName='string'
)
dict
Response Syntax
{
'FlowArn': 'string',
'NonDeletedNetworkInterfaceIds': [
'string',
],
'VpcInterfaceName': 'string'
}
Response Structure
Exceptions
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
See also: AWS API Documentation
Request Syntax
response = client.revoke_flow_entitlement(
EntitlementArn='string',
FlowArn='string'
)
dict
Response Syntax
{
'EntitlementArn': 'string',
'FlowArn': 'string'
}
Response Structure
Exceptions
Starts a flow.
See also: AWS API Documentation
Request Syntax
response = client.start_flow(
FlowArn='string'
)
{
'FlowArn': 'string',
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}
Response Structure
Exceptions
Stops a flow.
See also: AWS API Documentation
Request Syntax
response = client.stop_flow(
FlowArn='string'
)
{
'FlowArn': 'string',
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED] 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.
None
Exceptions
Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED] The keys of the tags to be removed.
None
Exceptions
Updates flow
See also: AWS API Documentation
Request Syntax
response = client.update_flow(
FlowArn='string',
SourceFailoverConfig={
'RecoveryWindow': 123,
'State': 'ENABLED'|'DISABLED'
}
)
The settings for source failover
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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'EntitlementStatus': 'ENABLED'|'DISABLED',
'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'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'EntitlementArn': 'string',
'ListenerAddress': 'string',
'MediaLiveInputArn': 'string',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
},
],
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': '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'|'srt-password',
'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,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
},
],
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
'VpcInterfaces': [
{
'Name': 'string',
'NetworkInterfaceIds': [
'string',
],
'RoleArn': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string'
},
]
}
}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_flow_entitlement(
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',
FlowArn='string',
Subscribers=[
'string',
]
)
The type of encryption that will be used on the output associated with this entitlement.
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.
dict
Response Syntax
{
'Entitlement': {
'DataTransferSubscriberFeePercent': 123,
'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'
}
Response Structure
Exceptions
Updates an existing flow output.
See also: AWS API Documentation
Request Syntax
response = client.update_flow_output(
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',
MaxLatency=123,
MinLatency=123,
OutputArn='string',
Port=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
RemoteId='string',
SmoothingLatency=123,
StreamId='string',
VpcInterfaceAttachment={
'VpcInterfaceName': 'string'
}
)
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.
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
The name of the VPC interface attachment to use for this output.
dict
Response Syntax
{
'FlowArn': 'string',
'Output': {
'DataTransferSubscriberFeePercent': 123,
'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',
'Name': 'string',
'OutputArn': 'string',
'Port': 123,
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceAttachment': {
'VpcInterfaceName': 'string'
}
}
}
Response Structure
Exceptions
Updates the source of a flow.
See also: AWS API Documentation
Request Syntax
response = client.update_flow_source(
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',
IngestPort=123,
MaxBitrate=123,
MaxLatency=123,
MinLatency=123,
Protocol='zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
SourceArn='string',
StreamId='string',
VpcInterfaceName='string',
WhitelistCidr='string'
)
The type of encryption used on the content ingested from this source.
dict
Response Syntax
{
'FlowArn': 'string',
'Source': {
'DataTransferSubscriberFeePercent': 123,
'Decryption': {
'Algorithm': 'aes128'|'aes192'|'aes256',
'ConstantInitializationVector': 'string',
'DeviceId': 'string',
'KeyType': 'speke'|'static-key'|'srt-password',
'Region': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SecretArn': 'string',
'Url': 'string'
},
'Description': 'string',
'EntitlementArn': 'string',
'IngestIp': 'string',
'IngestPort': 123,
'Name': 'string',
'SourceArn': 'string',
'Transport': {
'CidrAllowList': [
'string',
],
'MaxBitrate': 123,
'MaxLatency': 123,
'MinLatency': 123,
'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'srt-listener',
'RemoteId': 'string',
'SmoothingLatency': 123,
'StreamId': 'string'
},
'VpcInterfaceName': 'string',
'WhitelistCidr': 'string'
}
}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('list_entitlements')
Creates an iterator that will paginate through responses from MediaConnect.Client.list_entitlements().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entitlements': [
{
'DataTransferSubscriberFeePercent': 123,
'EntitlementArn': 'string',
'EntitlementName': 'string'
},
],
}
Response Structure
paginator = client.get_paginator('list_flows')
Creates an iterator that will paginate through responses from MediaConnect.Client.list_flows().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Flows': [
{
'AvailabilityZone': 'string',
'Description': 'string',
'FlowArn': 'string',
'Name': 'string',
'SourceType': 'OWNED'|'ENTITLED',
'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
},
],
}
Response Structure
paginator = client.get_paginator('list_offerings')
Creates an iterator that will paginate through responses from MediaConnect.Client.list_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Offerings': [
{
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
}
},
]
}
Response Structure
paginator = client.get_paginator('list_reservations')
Creates an iterator that will paginate through responses from MediaConnect.Client.list_reservations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Reservations': [
{
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
},
]
}
Response Structure
The available waiters are:
waiter = client.get_waiter('flow_active')
Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FlowArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('flow_deleted')
Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FlowArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('flow_standby')
Polls MediaConnect.Client.describe_flow() every 3 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FlowArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 40
None