StorageGateway / Paginator / ListGateways

ListGateways

class StorageGateway.Paginator.ListGateways

paginator = client.get_paginator('list_gateways')

paginate(**kwargs)

Creates an iterator that will paginate through responses from StorageGateway.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': [
        {
            'GatewayId': 'string',
            'GatewayARN': 'string',
            'GatewayType': 'string',
            'GatewayOperationalState': 'string',
            'GatewayName': 'string',
            'Ec2InstanceId': 'string',
            'Ec2InstanceRegion': 'string',
            'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
            'HostEnvironmentId': 'string',
            'DeprecationDate': 'string',
            'SoftwareVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Gateways (list) –

    An array of GatewayInfo objects.

    • (dict) –

      Describes a gateway object.

      • GatewayId (string) –

        The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

      • 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.

      • GatewayType (string) –

        The type of the gateway.

        Warning

        Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.

      • GatewayOperationalState (string) –

        The state of the gateway.

        Valid Values: DISABLED | ACTIVE

      • GatewayName (string) –

        The name of the gateway.

      • Ec2InstanceId (string) –

        The ID of the Amazon EC2 instance that was used to launch the gateway.

      • Ec2InstanceRegion (string) –

        The Amazon Web Services Region where the Amazon EC2 instance is located.

      • HostEnvironment (string) –

        The type of hardware or software platform on which the gateway is running.

        Note

        Tape Gateway is no longer available on Snow Family devices.

      • HostEnvironmentId (string) –

        A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

      • DeprecationDate (string) –

        Date after which this gateway will not receive software updates for new features and bug fixes.

      • SoftwareVersion (string) –

        The version number of the software running on the gateway appliance.

  • NextToken (string) –

    A token to resume pagination.