MediaConnect / Paginator / ListGateways

ListGateways¶

class MediaConnect.Paginator.ListGateways¶

paginator = client.get_paginator('list_gateways')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

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

{
    'Gateways': [
        {
            'GatewayArn': 'string',
            'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
            'Name': 'string'
        },
    ],

}

Response Structure

(dict) –
- Gateways (list) –
  
  A list of gateway summaries.
  - (dict) –
    
    A summary of a gateway, including its name, ARN, and status.
    - GatewayArn (string) –
      
      The Amazon Resource Name (ARN) of the gateway.
    - GatewayState (string) –
      
      The status of the gateway.
    - Name (string) –
      
      The name of the gateway.