DeadlineCloud / Client / list_storage_profiles_for_queue

list_storage_profiles_for_queue#

DeadlineCloud.Client.list_storage_profiles_for_queue(**kwargs)#

Lists storage profiles for a queue.

See also: AWS API Documentation

Request Syntax

response = client.list_storage_profiles_for_queue(
    farmId='string',
    maxResults=123,
    nextToken='string',
    queueId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID of the queue’s storage profile.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the storage profile.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

    • storageProfiles (list) –

      The storage profiles in the queue.

      • (dict) –

        The details of a storage profile.

        • displayName (string) –

          The display name of the storage profile summary to update.

        • osFamily (string) –

          The operating system (OS) family.

        • storageProfileId (string) –

          The storage profile ID.

Exceptions