StorageGateway / Paginator / ListVolumes

ListVolumes#

class StorageGateway.Paginator.ListVolumes#

paginator = client.get_paginator('list_volumes')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from StorageGateway.Client.list_volumes().

Request Syntax

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

Parameters:

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

{
    'GatewayARN': 'string',
    'VolumeInfos': [
        {
            'VolumeARN': 'string',
            'VolumeId': 'string',
            'GatewayARN': 'string',
            'GatewayId': 'string',
            'VolumeType': 'string',
            'VolumeSizeInBytes': 123,
            'VolumeAttachmentStatus': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

A JSON object containing the following fields:
- ListVolumesOutput$Marker
- ListVolumesOutput$VolumeInfos
- 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.
- VolumeInfos (list) –
  
  An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array “[]”.
  - (dict) –
    
    Describes a storage volume object.
    - VolumeARN (string) –
      
      The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
      
      arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
      
      Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
    - VolumeId (string) –
      
      The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
      
      Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
    - 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.
    - 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.
      
      Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
    - VolumeType (string) –
      
      One of the VolumeType enumeration values describing the type of the volume.
    - VolumeSizeInBytes (integer) –
      
      The size of the volume in bytes.
      
      Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
    - VolumeAttachmentStatus (string) –
      
      One of the VolumeStatus values that indicates the state of the storage volume.
- NextToken (string) –
  
  A token to resume pagination.