| 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.MediaStore.ListContainers
Description
Lists the properties of all containers in AWS Elemental MediaStore.
You can query to receive all the containers in one response. Or you can
include the MaxResults parameter to receive a limited number of
containers in each response. In this case, the response includes a
token. To get the next set of containers, send the command again, this
time with the NextToken parameter (with the returned token as its
value). The next set of responses appears, with a token if there are
still more containers to receive.
See also DescribeContainer, which gets the properties of one container.
This operation returns paginated results.
Synopsis
- data ListContainers = ListContainers' {}
- newListContainers :: ListContainers
- listContainers_nextToken :: Lens' ListContainers (Maybe Text)
- listContainers_maxResults :: Lens' ListContainers (Maybe Natural)
- data ListContainersResponse = ListContainersResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- containers :: [Container]
- newListContainersResponse :: Int -> ListContainersResponse
- listContainersResponse_nextToken :: Lens' ListContainersResponse (Maybe Text)
- listContainersResponse_httpStatus :: Lens' ListContainersResponse Int
- listContainersResponse_containers :: Lens' ListContainersResponse [Container]
Creating a Request
data ListContainers Source #
See: newListContainers smart constructor.
Constructors
| ListContainers' | |
Fields
| |
Instances
newListContainers :: ListContainers Source #
Create a value of ListContainers 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:nextToken:ListContainers', listContainers_nextToken - Only if you used MaxResults in the first command, enter the token
(which was included in the previous response) to obtain the next set of
containers. This token is included in a response only if there actually
are more containers to list.
$sel:maxResults:ListContainers', listContainers_maxResults - Enter the maximum number of containers in the response. Use from 1 to
255 characters.
Request Lenses
listContainers_nextToken :: Lens' ListContainers (Maybe Text) Source #
Only if you used MaxResults in the first command, enter the token
(which was included in the previous response) to obtain the next set of
containers. This token is included in a response only if there actually
are more containers to list.
listContainers_maxResults :: Lens' ListContainers (Maybe Natural) Source #
Enter the maximum number of containers in the response. Use from 1 to 255 characters.
Destructuring the Response
data ListContainersResponse Source #
See: newListContainersResponse smart constructor.
Constructors
| ListContainersResponse' | |
Fields
| |
Instances
newListContainersResponse Source #
Create a value of ListContainersResponse 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:nextToken:ListContainers', listContainersResponse_nextToken - NextToken is the token to use in the next call to ListContainers.
This token is returned only if you included the MaxResults tag in the
original command, and only if there are still containers to return.
$sel:httpStatus:ListContainersResponse', listContainersResponse_httpStatus - The response's http status code.
$sel:containers:ListContainersResponse', listContainersResponse_containers - The names of the containers.
Response Lenses
listContainersResponse_nextToken :: Lens' ListContainersResponse (Maybe Text) Source #
NextToken is the token to use in the next call to ListContainers.
This token is returned only if you included the MaxResults tag in the
original command, and only if there are still containers to return.
listContainersResponse_httpStatus :: Lens' ListContainersResponse Int Source #
The response's http status code.
listContainersResponse_containers :: Lens' ListContainersResponse [Container] Source #
The names of the containers.