DeadlineCloud / Paginator / ListStorageProfiles
ListStorageProfiles#
- class DeadlineCloud.Paginator.ListStorageProfiles#
paginator = client.get_paginator('list_storage_profiles')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
DeadlineCloud.Client.list_storage_profiles()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( farmId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
farmId (string) –
[REQUIRED]
The farm ID of 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': [ { 'displayName': 'string', 'osFamily': 'WINDOWS'|'LINUX'|'MACOS', 'storageProfileId': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
storageProfiles (list) –
The storage profiles.
(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.
NextToken (string) –
A token to resume pagination.