You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::MediaStoreData::Types::ListItemsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MediaStoreData::Types::ListItemsRequest
- Defined in:
- (unknown)
Overview
When passing ListItemsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
path: "ListPathNaming",
max_results: 1,
next_token: "PaginationToken",
}
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of results to return per API request.
-
#next_token ⇒ String
The token that identifies which batch of results that you want to see.
-
#path ⇒ String
The path in the container from which to retrieve items.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of results to return per API request. For example,
you submit a ListItems
request with MaxResults
set at 500. Although
2,000 items match your request, the service returns no more than the
first 500 items. (The service also returns a NextToken
value that you
can use to fetch the next batch of results.) The service might return
fewer results than the MaxResults
value.
If MaxResults
is not included in the request, the service defaults to
pagination with a maximum of 1,000 results per page.
#next_token ⇒ String
The token that identifies which batch of results that you want to see.
For example, you submit a ListItems
request with MaxResults
set at
500. The service returns the first batch of results (up to 500) and a
NextToken
value. To see the next batch of results, you can submit the
ListItems
request a second time and specify the NextToken
value.
Tokens expire after 15 minutes.
#path ⇒ String
The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>