AWS Elemental MediaLive

2018/12/06 - AWS Elemental MediaLive - 4 updated api methods

Changes  This release enables the AWS Elemental MediaConnect input type in AWS Elemental MediaLive. This can then be used to automatically create and manage AWS Elemental MediaConnect Flow Outputs when you create a channel using those inputs.

CreateInput (updated) Link ¶
Changes (request, response)
Request 
{'MediaConnectFlows': [{'FlowArn': 'string'}],
 'RoleArn': 'string',
 'Type': {'MEDIACONNECT'}}
Response 
{'Input': {'MediaConnectFlows': [{'FlowArn': 'string'}],
           'RoleArn': 'string',
           'Type': {'MEDIACONNECT'}}}

Create an input

See also: AWS API Documentation

Request Syntax

client.create_input(
    Destinations=[
        {
            'StreamName': 'string'
        },
    ],
    InputSecurityGroups=[
        'string',
    ],
    MediaConnectFlows=[
        {
            'FlowArn': 'string'
        },
    ],
    Name='string',
    RequestId='string',
    RoleArn='string',
    Sources=[
        {
            'PasswordParam': 'string',
            'Url': 'string',
            'Username': 'string'
        },
    ],
    Type='UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'
)
type Destinations

list

param Destinations

Destination settings for PUSH type inputs.

  • (dict) -- Endpoint settings for a PUSH type input.

    • StreamName (string) -- A unique name for the location the RTMP stream is being pushed to.

type InputSecurityGroups

list

param InputSecurityGroups

A list of security groups referenced by IDs to attach to the input.

  • (string) -- Placeholder documentation for __string

type MediaConnectFlows

list

param MediaConnectFlows

A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

  • (dict) -- The settings for a MediaConnect Flow.

    • FlowArn (string) -- The ARN of the MediaConnect Flow that you want to use as a source.

type Name

string

param Name

Name of the input.

type RequestId

string

param RequestId

Unique identifier of the request to ensure the request is handled exactly once in case of retries. This field is autopopulated if not provided.

type RoleArn

string

param RoleArn

The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

type Sources

list

param Sources

The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

  • (dict) -- Settings for for a PULL type input.

    • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

    • Url (string) -- This represents the customer's source URL where stream is pulled from.

    • Username (string) -- The username for the input source.

type Type

string

param Type

Placeholder documentation for InputType

rtype

dict

returns

Response Syntax

{
    'Input': {
        'Arn': 'string',
        'AttachedChannels': [
            'string',
        ],
        'Destinations': [
            {
                'Ip': 'string',
                'Port': 'string',
                'Url': 'string'
            },
        ],
        'Id': 'string',
        'MediaConnectFlows': [
            {
                'FlowArn': 'string'
            },
        ],
        'Name': 'string',
        'RoleArn': 'string',
        'SecurityGroups': [
            'string',
        ],
        'Sources': [
            {
                'PasswordParam': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ],
        'State': 'CREATING'|'DETACHED'|'ATTACHED'|'DELETING'|'DELETED',
        'Type': 'UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'
    }
}

Response Structure

  • (dict) -- Successfully created the input.

    • Input (dict) -- Placeholder documentation for Input

      • Arn (string) -- The Unique ARN of the input (generated, immutable).

      • AttachedChannels (list) -- A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

        • (string) -- Placeholder documentation for __string

      • Destinations (list) -- A list of the destinations of the input (PUSH-type).

        • (dict) -- The settings for a PUSH type input.

          • Ip (string) -- The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

          • Port (string) -- The port number for the input.

          • Url (string) -- This represents the endpoint that the customer stream will be pushed to.

      • Id (string) -- The generated ID of the input (unique for user account, immutable).

      • MediaConnectFlows (list) -- A list of MediaConnect Flows for this input.

        • (dict) -- The settings for a MediaConnect Flow.

          • FlowArn (string) -- The unique ARN of the MediaConnect Flow being used as a source.

      • Name (string) -- The user-assigned name (This is a mutable value).

      • RoleArn (string) -- The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

      • SecurityGroups (list) -- A list of IDs for all the security groups attached to the input.

        • (string) -- Placeholder documentation for __string

      • Sources (list) -- A list of the sources of the input (PULL-type).

        • (dict) -- The settings for a PULL type input.

          • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

          • Url (string) -- This represents the customer's source URL where stream is pulled from.

          • Username (string) -- The username for the input source.

      • State (string) -- Placeholder documentation for InputState

      • Type (string) -- Placeholder documentation for InputType

DescribeInput (updated) Link ¶
Changes (response) 
{'MediaConnectFlows': [{'FlowArn': 'string'}],
 'RoleArn': 'string',
 'Type': {'MEDIACONNECT'}}

Produces details about an input

See also: AWS API Documentation

Request Syntax

client.describe_input(
    InputId='string'
)
type InputId

string

param InputId

[REQUIRED] Unique ID of the input

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'AttachedChannels': [
        'string',
    ],
    'Destinations': [
        {
            'Ip': 'string',
            'Port': 'string',
            'Url': 'string'
        },
    ],
    'Id': 'string',
    'MediaConnectFlows': [
        {
            'FlowArn': 'string'
        },
    ],
    'Name': 'string',
    'RoleArn': 'string',
    'SecurityGroups': [
        'string',
    ],
    'Sources': [
        {
            'PasswordParam': 'string',
            'Url': 'string',
            'Username': 'string'
        },
    ],
    'State': 'CREATING'|'DETACHED'|'ATTACHED'|'DELETING'|'DELETED',
    'Type': 'UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'
}

Response Structure

  • (dict) -- Input details

    • Arn (string) -- The Unique ARN of the input (generated, immutable).

    • AttachedChannels (list) -- A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

      • (string) -- Placeholder documentation for __string

    • Destinations (list) -- A list of the destinations of the input (PUSH-type).

      • (dict) -- The settings for a PUSH type input.

        • Ip (string) -- The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

        • Port (string) -- The port number for the input.

        • Url (string) -- This represents the endpoint that the customer stream will be pushed to.

    • Id (string) -- The generated ID of the input (unique for user account, immutable).

    • MediaConnectFlows (list) -- A list of MediaConnect Flows for this input.

      • (dict) -- The settings for a MediaConnect Flow.

        • FlowArn (string) -- The unique ARN of the MediaConnect Flow being used as a source.

    • Name (string) -- The user-assigned name (This is a mutable value).

    • RoleArn (string) -- The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

    • SecurityGroups (list) -- A list of IDs for all the security groups attached to the input.

      • (string) -- Placeholder documentation for __string

    • Sources (list) -- A list of the sources of the input (PULL-type).

      • (dict) -- The settings for a PULL type input.

        • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

        • Url (string) -- This represents the customer's source URL where stream is pulled from.

        • Username (string) -- The username for the input source.

    • State (string) -- Placeholder documentation for InputState

    • Type (string) -- Placeholder documentation for InputType

ListInputs (updated) Link ¶
Changes (response) 
{'Inputs': {'MediaConnectFlows': [{'FlowArn': 'string'}],
            'RoleArn': 'string',
            'Type': {'MEDIACONNECT'}}}

Produces list of inputs that have been created

See also: AWS API Documentation

Request Syntax

client.list_inputs(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

Placeholder documentation for MaxResults

type NextToken

string

param NextToken

Placeholder documentation for __string

rtype

dict

returns

Response Syntax

{
    'Inputs': [
        {
            'Arn': 'string',
            'AttachedChannels': [
                'string',
            ],
            'Destinations': [
                {
                    'Ip': 'string',
                    'Port': 'string',
                    'Url': 'string'
                },
            ],
            'Id': 'string',
            'MediaConnectFlows': [
                {
                    'FlowArn': 'string'
                },
            ],
            'Name': 'string',
            'RoleArn': 'string',
            'SecurityGroups': [
                'string',
            ],
            'Sources': [
                {
                    'PasswordParam': 'string',
                    'Url': 'string',
                    'Username': 'string'
                },
            ],
            'State': 'CREATING'|'DETACHED'|'ATTACHED'|'DELETING'|'DELETED',
            'Type': 'UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- An array of inputs

    • Inputs (list) -- Placeholder documentation for __listOfInput

      • (dict) -- Placeholder documentation for Input

        • Arn (string) -- The Unique ARN of the input (generated, immutable).

        • AttachedChannels (list) -- A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

          • (string) -- Placeholder documentation for __string

        • Destinations (list) -- A list of the destinations of the input (PUSH-type).

          • (dict) -- The settings for a PUSH type input.

            • Ip (string) -- The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

            • Port (string) -- The port number for the input.

            • Url (string) -- This represents the endpoint that the customer stream will be pushed to.

        • Id (string) -- The generated ID of the input (unique for user account, immutable).

        • MediaConnectFlows (list) -- A list of MediaConnect Flows for this input.

          • (dict) -- The settings for a MediaConnect Flow.

            • FlowArn (string) -- The unique ARN of the MediaConnect Flow being used as a source.

        • Name (string) -- The user-assigned name (This is a mutable value).

        • RoleArn (string) -- The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

        • SecurityGroups (list) -- A list of IDs for all the security groups attached to the input.

          • (string) -- Placeholder documentation for __string

        • Sources (list) -- A list of the sources of the input (PULL-type).

          • (dict) -- The settings for a PULL type input.

            • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

            • Url (string) -- This represents the customer's source URL where stream is pulled from.

            • Username (string) -- The username for the input source.

        • State (string) -- Placeholder documentation for InputState

        • Type (string) -- Placeholder documentation for InputType

    • NextToken (string) -- Placeholder documentation for __string

UpdateInput (updated) Link ¶
Changes (request, response)
Request 
{'MediaConnectFlows': [{'FlowArn': 'string'}], 'RoleArn': 'string'}
Response 
{'Input': {'MediaConnectFlows': [{'FlowArn': 'string'}],
           'RoleArn': 'string',
           'Type': {'MEDIACONNECT'}}}

Updates an input.

See also: AWS API Documentation

Request Syntax

client.update_input(
    Destinations=[
        {
            'StreamName': 'string'
        },
    ],
    InputId='string',
    InputSecurityGroups=[
        'string',
    ],
    MediaConnectFlows=[
        {
            'FlowArn': 'string'
        },
    ],
    Name='string',
    RoleArn='string',
    Sources=[
        {
            'PasswordParam': 'string',
            'Url': 'string',
            'Username': 'string'
        },
    ]
)
type Destinations

list

param Destinations

Destination settings for PUSH type inputs.

  • (dict) -- Endpoint settings for a PUSH type input.

    • StreamName (string) -- A unique name for the location the RTMP stream is being pushed to.

type InputId

string

param InputId

[REQUIRED] Unique ID of the input.

type InputSecurityGroups

list

param InputSecurityGroups

A list of security groups referenced by IDs to attach to the input.

  • (string) -- Placeholder documentation for __string

type MediaConnectFlows

list

param MediaConnectFlows

A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

  • (dict) -- The settings for a MediaConnect Flow.

    • FlowArn (string) -- The ARN of the MediaConnect Flow that you want to use as a source.

type Name

string

param Name

Name of the input.

type RoleArn

string

param RoleArn

The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

type Sources

list

param Sources

The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

  • (dict) -- Settings for for a PULL type input.

    • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

    • Url (string) -- This represents the customer's source URL where stream is pulled from.

    • Username (string) -- The username for the input source.

rtype

dict

returns

Response Syntax

{
    'Input': {
        'Arn': 'string',
        'AttachedChannels': [
            'string',
        ],
        'Destinations': [
            {
                'Ip': 'string',
                'Port': 'string',
                'Url': 'string'
            },
        ],
        'Id': 'string',
        'MediaConnectFlows': [
            {
                'FlowArn': 'string'
            },
        ],
        'Name': 'string',
        'RoleArn': 'string',
        'SecurityGroups': [
            'string',
        ],
        'Sources': [
            {
                'PasswordParam': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ],
        'State': 'CREATING'|'DETACHED'|'ATTACHED'|'DELETING'|'DELETED',
        'Type': 'UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'
    }
}

Response Structure

  • (dict) -- The input update is successfully initiated.

    • Input (dict) -- Placeholder documentation for Input

      • Arn (string) -- The Unique ARN of the input (generated, immutable).

      • AttachedChannels (list) -- A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

        • (string) -- Placeholder documentation for __string

      • Destinations (list) -- A list of the destinations of the input (PUSH-type).

        • (dict) -- The settings for a PUSH type input.

          • Ip (string) -- The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

          • Port (string) -- The port number for the input.

          • Url (string) -- This represents the endpoint that the customer stream will be pushed to.

      • Id (string) -- The generated ID of the input (unique for user account, immutable).

      • MediaConnectFlows (list) -- A list of MediaConnect Flows for this input.

        • (dict) -- The settings for a MediaConnect Flow.

          • FlowArn (string) -- The unique ARN of the MediaConnect Flow being used as a source.

      • Name (string) -- The user-assigned name (This is a mutable value).

      • RoleArn (string) -- The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

      • SecurityGroups (list) -- A list of IDs for all the security groups attached to the input.

        • (string) -- Placeholder documentation for __string

      • Sources (list) -- A list of the sources of the input (PULL-type).

        • (dict) -- The settings for a PULL type input.

          • PasswordParam (string) -- The key used to extract the password from EC2 Parameter store.

          • Url (string) -- This represents the customer's source URL where stream is pulled from.

          • Username (string) -- The username for the input source.

      • State (string) -- Placeholder documentation for InputState

      • Type (string) -- Placeholder documentation for InputType