ListContainers
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.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
Enter the maximum number of containers in the response. Use from 1 to 255 characters.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[0-9A-Za-z=/+]+
Required: No
Response Syntax
{
"Containers": [
{
"AccessLoggingEnabled": boolean,
"ARN": "string",
"CreationTime": number,
"Endpoint": "string",
"Name": "string",
"Status": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Containers
-
The names of the containers.
Type: Array of Container objects
- NextToken
-
NextToken
is the token to use in the next call toListContainers
. This token is returned only if you included theMaxResults
tag in the original command, and only if there are still containers to return.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[0-9A-Za-z=/+]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
The service is temporarily unavailable.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: