AWS API Changes

2020/10/07 - AWS Elemental MediaPackage - 1 new6 updated api methods

Changes Update mediapackage client to latest version

ConfigureLogs (new)

Link ¶

Changes the Channel's properities to configure log subscription

Request Syntax

client.configure_logs(
    EgressAccessLogs={
        'LogGroupName': 'string'
    },
    Id='string',
    IngressAccessLogs={
        'LogGroupName': 'string'
    }
)

type EgressAccessLogs:

dict

param EgressAccessLogs:

Configure egress access logging.

LogGroupName (string) -- Customize the log group name.

type Id:

string

param Id:

[REQUIRED] The ID of the channel to log subscription.

type IngressAccessLogs:

dict

param IngressAccessLogs:

Configure ingress access logging.

LogGroupName (string) -- Customize the log group name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated log configuration record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

CreateChannel (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'},
 'IngressAccessLogs': {'LogGroupName': 'string'}}

Creates a new Channel.

See also: AWS API Documentation

Request Syntax

client.create_channel(
    Description='string',
    Id='string',
    Tags={
        'string': 'string'
    }
)

type Description:

string

param Description:

A short text description of the Channel.

type Id:

string

param Id:

[REQUIRED] The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is created.

type Tags:

dict

param Tags:

A collection of tags associated with a resource

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The new Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

DescribeChannel (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'},
 'IngressAccessLogs': {'LogGroupName': 'string'}}

Gets details about a Channel.

See also: AWS API Documentation

Request Syntax

client.describe_channel(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED] The ID of a Channel.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- A Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

ListChannels (updated)

Link ¶
Changes (response)

{'Channels': {'EgressAccessLogs': {'LogGroupName': 'string'},
              'IngressAccessLogs': {'LogGroupName': 'string'}}}

Returns a collection of Channels.

See also: AWS API Documentation

Request Syntax

client.list_channels(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

Upper bound on number of records to return.

type NextToken:

string

param NextToken:

A token used to resume pagination from the end of a previous request.

rtype:

dict

returns:

Response Syntax

{
    'Channels': [
        {
            'Arn': 'string',
            'Description': 'string',
            'EgressAccessLogs': {
                'LogGroupName': 'string'
            },
            'HlsIngest': {
                'IngestEndpoints': [
                    {
                        'Id': 'string',
                        'Password': 'string',
                        'Url': 'string',
                        'Username': 'string'
                    },
                ]
            },
            'Id': 'string',
            'IngressAccessLogs': {
                'LogGroupName': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- A collection of Channel records.
- Channels (list) -- A list of Channel records.
  - (dict) -- A Channel resource configuration.
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
    - Description (string) -- A short text description of the Channel.
    - EgressAccessLogs (dict) -- Configure egress access logging.
      - LogGroupName (string) -- Customize the log group name.
    - HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
      - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
        
        (dict) -- An endpoint for ingesting source content for a Channel.
        
        Id (string) -- The system generated unique identifier for the IngestEndpoint
        
        Password (string) -- The system generated password for ingest authentication.
        
        Url (string) -- The ingest URL to which the source stream should be sent.
        
        Username (string) -- The system generated username for ingest authentication.
    - Id (string) -- The ID of the Channel.
    - IngressAccessLogs (dict) -- Configure ingress access logging.
      - LogGroupName (string) -- Customize the log group name.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --
- NextToken (string) -- A token that can be used to resume pagination from the end of the collection.

RotateChannelCredentials (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'},
 'IngressAccessLogs': {'LogGroupName': 'string'}}

Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead

See also: AWS API Documentation

Request Syntax

client.rotate_channel_credentials(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED] The ID of the channel to update.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

RotateIngestEndpointCredentials (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'},
 'IngressAccessLogs': {'LogGroupName': 'string'}}

Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.

See also: AWS API Documentation

Request Syntax

client.rotate_ingest_endpoint_credentials(
    Id='string',
    IngestEndpointId='string'
)

type Id:

string

param Id:

[REQUIRED] The ID of the channel the IngestEndpoint is on.

type IngestEndpointId:

string

param IngestEndpointId:

[REQUIRED] The id of the IngestEndpoint whose credentials should be rotated

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

UpdateChannel (updated)

Link ¶
Changes (response)

{'EgressAccessLogs': {'LogGroupName': 'string'},
 'IngressAccessLogs': {'LogGroupName': 'string'}}

Updates an existing Channel.

See also: AWS API Documentation

Request Syntax

client.update_channel(
    Description='string',
    Id='string'
)

type Description:

string

param Description:

A short text description of the Channel.

type Id:

string

param Id:

[REQUIRED] The ID of the Channel to update.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- EgressAccessLogs (dict) -- Configure egress access logging.
  - LogGroupName (string) -- Customize the log group name.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- IngressAccessLogs (dict) -- Configure ingress access logging.
  - LogGroupName (string) -- Customize the log group name.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --