We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.
Essential cookies are necessary to provide our site and services and cannot be deactivated. They are usually set in response to your actions on the site, such as setting your privacy preferences, signing in, or filling in forms.
Performance cookies provide anonymous statistics about how customers navigate our site so we can improve site experience and performance. Approved third parties may perform analytics on our behalf, but they cannot use the data for their own purposes.
Functional cookies help us provide useful site features, remember your preferences, and display relevant content. Approved third parties may set these cookies to provide certain site features. If you do not allow these cookies, then some or all of these services may not function properly.
Advertising cookies may be set through our site by us or our advertising partners and help us deliver relevant marketing content. If you do not allow these cookies, you will experience less relevant advertising.
Blocking some types of cookies may impact your experience of our sites. You may review and change your choices at any time by clicking Cookie preferences in the footer of this site. We and selected third-parties use cookies or similar technologies as specified in the AWS Cookie Notice.
StorageGateway.Paginator.
ListFileShares
¶paginator = client.get_paginator('list_file_shares')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_file_shares()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'FileShareInfoList': [
{
'FileShareType': 'NFS'|'SMB',
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ListFileShareOutput
Marker (string) --
If the request includes Marker
, the response returns that value in this field.
FileShareInfoList (list) --
An array of information about the S3 File Gateway's file shares.
(dict) --
Describes a file share. Only supported S3 File Gateway.
FileShareType (string) --
The type of the file share.
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share.
Valid Values: CREATING
| UPDATING
| AVAILABLE
| DELETING
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.