| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MediaStoreData.ListItems
Description
Provides a list of metadata entries about folders and objects in the specified folder.
This operation returns paginated results.
Synopsis
- data ListItems = ListItems' {}
- newListItems :: ListItems
- listItems_path :: Lens' ListItems (Maybe Text)
- listItems_nextToken :: Lens' ListItems (Maybe Text)
- listItems_maxResults :: Lens' ListItems (Maybe Natural)
- data ListItemsResponse = ListItemsResponse' {}
- newListItemsResponse :: Int -> ListItemsResponse
- listItemsResponse_items :: Lens' ListItemsResponse (Maybe [Item])
- listItemsResponse_nextToken :: Lens' ListItemsResponse (Maybe Text)
- listItemsResponse_httpStatus :: Lens' ListItemsResponse Int
Creating a Request
See: newListItems smart constructor.
Constructors
| ListItems' | |
Fields
| |
Instances
newListItems :: ListItems Source #
Create a value of ListItems with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:path:ListItems', listItems_path - The path in the container from which to retrieve items. Format: <folder
name>/<folder name>/<file name>
$sel:nextToken:ListItems', listItems_nextToken - 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.
$sel:maxResults:ListItems', listItems_maxResults - 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.
Request Lenses
listItems_path :: Lens' ListItems (Maybe Text) Source #
The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>
listItems_nextToken :: Lens' ListItems (Maybe Text) Source #
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.
listItems_maxResults :: Lens' ListItems (Maybe Natural) Source #
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.
Destructuring the Response
data ListItemsResponse Source #
See: newListItemsResponse smart constructor.
Constructors
| ListItemsResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListItemsResponse |
Create a value of ListItemsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:items:ListItemsResponse', listItemsResponse_items - The metadata entries for the folders and objects at the requested path.
$sel:nextToken:ListItems', listItemsResponse_nextToken - The token that can be used in a request to view the next set of results.
For example, you submit a ListItems request that matches 2,000 items
with MaxResults set at 500. The service returns the first batch of
results (up to 500) and a NextToken value that can be used to fetch
the next batch of results.
$sel:httpStatus:ListItemsResponse', listItemsResponse_httpStatus - The response's http status code.
Response Lenses
listItemsResponse_items :: Lens' ListItemsResponse (Maybe [Item]) Source #
The metadata entries for the folders and objects at the requested path.
listItemsResponse_nextToken :: Lens' ListItemsResponse (Maybe Text) Source #
The token that can be used in a request to view the next set of results.
For example, you submit a ListItems request that matches 2,000 items
with MaxResults set at 500. The service returns the first batch of
results (up to 500) and a NextToken value that can be used to fetch
the next batch of results.
listItemsResponse_httpStatus :: Lens' ListItemsResponse Int Source #
The response's http status code.