AWS API Changes

2020/09/18 - AWS Elemental MediaLive - 3 new api methods

Changes AWS Elemental MediaLive now supports batch operations, which allow users to start, stop, and delete multiple MediaLive resources with a single request.

BatchDelete (new)

Link ¶

Starts delete of resources.

See also: AWS API Documentation

Request Syntax

client.batch_delete(
    ChannelIds=[
        'string',
    ],
    InputIds=[
        'string',
    ],
    InputSecurityGroupIds=[
        'string',
    ],
    MultiplexIds=[
        'string',
    ]
)

type ChannelIds

list

param ChannelIds

List of channel IDs

(string) -- Placeholder documentation for __string

type InputIds

list

param InputIds

List of input IDs

(string) -- Placeholder documentation for __string

type InputSecurityGroupIds

list

param InputSecurityGroupIds

List of input security group IDs

(string) -- Placeholder documentation for __string

type MultiplexIds

list

param MultiplexIds

List of multiplex IDs

(string) -- Placeholder documentation for __string

rtype

dict

returns

Response Syntax

{
    'Failed': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Id': 'string',
            'Message': 'string'
        },
    ],
    'Successful': [
        {
            'Arn': 'string',
            'Id': 'string',
            'State': 'string'
        },
    ]
}

Response Structure

(dict) -- Delete was successfully initiated.
- Failed (list) -- List of failed operations
  - (dict) -- Details from a failed operation
    - Arn (string) -- ARN of the resource
    - Code (string) -- Error code for the failed operation
    - Id (string) -- ID of the resource
    - Message (string) -- Error message for the failed operation
- Successful (list) -- List of successful operations
  - (dict) -- Details from a successful operation
    - Arn (string) -- ARN of the resource
    - Id (string) -- ID of the resource
    - State (string) -- Current state of the resource

BatchStop (new)

Link ¶

Stops running resources

See also: AWS API Documentation

Request Syntax

client.batch_stop(
    ChannelIds=[
        'string',
    ],
    MultiplexIds=[
        'string',
    ]
)

type ChannelIds

list

param ChannelIds

List of channel IDs

(string) -- Placeholder documentation for __string

type MultiplexIds

list

param MultiplexIds

List of multiplex IDs

(string) -- Placeholder documentation for __string

rtype

dict

returns

Response Syntax

{
    'Failed': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Id': 'string',
            'Message': 'string'
        },
    ],
    'Successful': [
        {
            'Arn': 'string',
            'Id': 'string',
            'State': 'string'
        },
    ]
}

Response Structure

(dict) -- Successfully initiated stop of the resources.
- Failed (list) -- List of failed operations
  - (dict) -- Details from a failed operation
    - Arn (string) -- ARN of the resource
    - Code (string) -- Error code for the failed operation
    - Id (string) -- ID of the resource
    - Message (string) -- Error message for the failed operation
- Successful (list) -- List of successful operations
  - (dict) -- Details from a successful operation
    - Arn (string) -- ARN of the resource
    - Id (string) -- ID of the resource
    - State (string) -- Current state of the resource

BatchStart (new)

Link ¶

Starts existing resources

See also: AWS API Documentation

Request Syntax

client.batch_start(
    ChannelIds=[
        'string',
    ],
    MultiplexIds=[
        'string',
    ]
)

type ChannelIds

list

param ChannelIds

List of channel IDs

(string) -- Placeholder documentation for __string

type MultiplexIds

list

param MultiplexIds

List of multiplex IDs

(string) -- Placeholder documentation for __string

rtype

dict

returns

Response Syntax

{
    'Failed': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Id': 'string',
            'Message': 'string'
        },
    ],
    'Successful': [
        {
            'Arn': 'string',
            'Id': 'string',
            'State': 'string'
        },
    ]
}

Response Structure

(dict) -- Successfully initiated start of resources.
- Failed (list) -- List of failed operations
  - (dict) -- Details from a failed operation
    - Arn (string) -- ARN of the resource
    - Code (string) -- Error code for the failed operation
    - Id (string) -- ID of the resource
    - Message (string) -- Error message for the failed operation
- Successful (list) -- List of successful operations
  - (dict) -- Details from a successful operation
    - Arn (string) -- ARN of the resource
    - Id (string) -- ID of the resource
    - State (string) -- Current state of the resource