DeadlineCloud / Client / list_storage_profiles

list_storage_profiles

DeadlineCloud.Client.list_storage_profiles(**kwargs)

Lists storage profiles.

See also: AWS API Documentation

Request Syntax

response = client.list_storage_profiles(
    farmId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the storage profile.

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

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

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.

    • (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) –

    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.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException