DeadlineCloud / Paginator / ListStorageProfilesForQueue

ListStorageProfilesForQueue

class DeadlineCloud.Paginator.ListStorageProfilesForQueue

paginator = client.get_paginator('list_storage_profiles_for_queue')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the queue’s storage profile.

• queueId (string) –

  [REQUIRED]

  The queue ID for the storage profile.

• 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

{
    'storageProfiles': [
        {
            'storageProfileId': 'string',
            'displayName': 'string',
            'osFamily': 'WINDOWS'|'LINUX'|'MACOS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • storageProfiles (list) –

    The storage profiles in the queue.

    • (dict) –

      The details of a storage profile.

      • storageProfileId (string) –

        The storage profile ID.

      • displayName (string) –

        The display name of the storage profile summary to update.

        Warning

        This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      • osFamily (string) –

        The operating system (OS) family.

  • NextToken (string) –

    A token to resume pagination.