batch_stop

MediaLive.Client.batch_stop(**kwargs)

Stops running resources

See also: AWS API Documentation

Request Syntax

response = client.batch_stop(
    ChannelIds=[
        'string',
    ],
    MultiplexIds=[
        'string',
    ]
)
Parameters
  • ChannelIds (list) --

    List of channel IDs

    • (string) -- Placeholder documentation for __string
  • MultiplexIds (list) --

    List of multiplex IDs

    • (string) -- Placeholder documentation for __string
Return type

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

Exceptions

  • MediaLive.Client.exceptions.BadRequestException
  • MediaLive.Client.exceptions.InternalServerErrorException
  • MediaLive.Client.exceptions.ForbiddenException
  • MediaLive.Client.exceptions.BadGatewayException
  • MediaLive.Client.exceptions.NotFoundException
  • MediaLive.Client.exceptions.GatewayTimeoutException
  • MediaLive.Client.exceptions.TooManyRequestsException
  • MediaLive.Client.exceptions.ConflictException