BackupGateway / Paginator / ListGateways

ListGateways

class BackupGateway.Paginator.ListGateways

paginator = client.get_paginator('list_gateways')

paginate(**kwargs)

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

See also: AWS API Documentation

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',
            'GatewayDisplayName': 'string',
            'GatewayType': 'BACKUP_VM',
            'HypervisorId': 'string',
            'LastSeenTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Gateways (list) –

    A list of your gateways.

    • (dict) –

      A gateway is an Backup Gateway appliance that runs on the customer’s network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

      • GatewayArn (string) –

        The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

      • GatewayDisplayName (string) –

        The display name of the gateway.

      • GatewayType (string) –

        The type of the gateway.

      • HypervisorId (string) –

        The hypervisor ID of the gateway.

      • LastSeenTime (datetime) –

        The last time Backup gateway communicated with the gateway, in Unix format and UTC time.