DeadlineCloud / Paginator / ListVolumes

ListVolumes

class DeadlineCloud.Paginator.ListVolumes

paginator = client.get_paginator('list_volumes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the farm that contains the fleet.

• fleetId (string) –

  [REQUIRED]

  The fleet ID of the fleet that contains the volumes.

• 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

{
    'volumes': [
        {
            'volumeId': 'string',
            'farmId': 'string',
            'fleetId': 'string',
            'state': 'PENDING_CREATION'|'PENDING_ATTACHMENT'|'IN_USE'|'AVAILABLE'|'PENDING_DELETION',
            'sizeGiB': 123,
            'availabilityZoneId': 'string',
            'attachedWorkerId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Shared pagination field for List operation outputs (nextToken).

  • volumes (list) –

    The volumes on the list.

    • (dict) –

      The summary of a persistent volume.

      • volumeId (string) –

        The volume ID.

      • farmId (string) –

        The farm ID of the farm that contains the fleet.

      • fleetId (string) –

        The fleet ID of the fleet that contains the volume.

      • state (string) –

        The state of the volume.

      • sizeGiB (integer) –

        The volume size in GiB.

      • availabilityZoneId (string) –

        The Availability Zone ID of the volume.

      • attachedWorkerId (string) –

        The worker ID of the worker the volume is attached to.

  • NextToken (string) –

    A token to resume pagination.