Class DescribeContainerCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { MediaStoreClient, DescribeContainerCommand } from "@aws-sdk/client-mediastore"; // ES Modules import
// const { MediaStoreClient, DescribeContainerCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import
const client = new MediaStoreClient(config);
const input = { // DescribeContainerInput
  ContainerName: "STRING_VALUE",
};
const command = new DescribeContainerCommand(input);
const response = await client.send(command);
// { // DescribeContainerOutput
//   Container: { // Container
//     Endpoint: "STRING_VALUE",
//     CreationTime: new Date("TIMESTAMP"),
//     ARN: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     AccessLoggingEnabled: true || false,
//   },
// };

Param

DescribeContainerCommandInput

Returns

DescribeContainerCommandOutput

See

• DescribeContainerCommandInput for command's input shape.
• DescribeContainerCommandOutput for command's response shape.
• config for MediaStoreClient's config shape.

Throws

ContainerNotFoundException (client fault)

The container that you specified in the request does not exist.

Throws

InternalServerError (server fault)

The service is temporarily unavailable.

Throws

MediaStoreServiceException

Base exception class for all service exceptions from MediaStore service.