MediaConnect / Client / list_bridges

list_bridges#

MediaConnect.Client.list_bridges(**kwargs)#

Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result.

Request Syntax

response = client.list_bridges(
    FilterArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

FilterArn (string) – Filter the list results to display only the bridges associated with the selected ARN.
MaxResults (integer) –
The maximum number of results to return per API request.

For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
NextToken (string) –
The token that identifies the batch of results that you want to see.

For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Bridges (list) –
  
  A list of bridge summaries.
  - (dict) –
    
    Displays details of the selected bridge.
    - BridgeArn (string) –
      
      The ARN of the bridge.
    - BridgeState (string) –
      
      The state of the bridge.
    - 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.
- NextToken (string) –
  
  The token that identifies the batch of results that you want to see.
  
  For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.ConflictException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ServiceUnavailableException