DescribeContainer
Retrieves the properties of the requested container. This request is commonly used to
retrieve the endpoint of a container. An endpoint is a value assigned by the service when a
new container is created. A container's endpoint does not change after it has been
assigned. The DescribeContainer
request returns a single
Container
object based on ContainerName
. To return all
Container
objects that are associated with a specified AWS account, use
ListContainers.
Request Syntax
{
"ContainerName": "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.
- ContainerName
-
The name of the container to query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\w-]+
Required: No
Response Syntax
{
"Container": {
"AccessLoggingEnabled": boolean,
"ARN": "string",
"CreationTime": number,
"Endpoint": "string",
"Name": "string",
"Status": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ContainerNotFoundException
-
The container that you specified in the request does not exist.
HTTP Status Code: 400
- 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: