describe_container

describe_container(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_container(
    ContainerName='string'
)

Parameters

ContainerName (string) -- The name of the container to query.

Return type

dict

Returns

Response Syntax

{
    'Container': {
        'Endpoint': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'ARN': 'string',
        'Name': 'string',
        'Status': 'ACTIVE'|'CREATING'|'DELETING',
        'AccessLoggingEnabled': True|False
    }
}

Response Structure

• (dict) --
  • Container (dict) --

    The name of the queried container.

    • Endpoint (string) --

      The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.

    • CreationTime (datetime) --

      Unix timestamp.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the container. The ARN has the following format:

      arn:aws:<region>:<account that owns this container>:container/<name of container>

      For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

    • Name (string) --

      The name of the container.

    • Status (string) --

      The status of container creation or deletion. The status is one of the following: CREATING , ACTIVE , or DELETING . While the service is creating the container, the status is CREATING . When the endpoint is available, the status changes to ACTIVE .

    • AccessLoggingEnabled (boolean) --

      The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true , indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

Exceptions

• MediaStore.Client.exceptions.ContainerNotFoundException
• MediaStore.Client.exceptions.InternalServerError