MediaConnect / Paginator / ListBridges

ListBridges

class MediaConnect.Paginator.ListBridges

paginator = client.get_paginator('list_bridges')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_bridges().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FilterArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FilterArn (string) – Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN).

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    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.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Bridges': [
        {
            'BridgeArn': 'string',
            'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
            'BridgeType': 'string',
            'Name': 'string',
            'PlacementArn': 'string'
        },
    ],

}

Response Structure

• (dict) – AWS Elemental MediaConnect returned the list of bridges successfully.

  • Bridges (list) – A list of bridge summaries.

    • (dict) – Displays details of the selected bridge.

      • BridgeArn (string) – The ARN of the bridge.

      • BridgeState (string) –

      • BridgeType (string) – The type of the bridge.

      • Name (string) – The name of the bridge.

      • PlacementArn (string) – The ARN of the gateway associated with the bridge.