MediaStore / Client / create_container

create_container

MediaStore.Client.create_container(**kwargs)

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

See also: AWS API Documentation

Request Syntax

response = client.create_container(
    ContainerName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ContainerName (string) –

  [REQUIRED]

  The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

• Tags (list) –

  An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

  • (dict) –

    A collection of tags associated with a container. Each tag consists of a key:value pair, which can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

    • Key (string) – [REQUIRED]

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

    • Value (string) –

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

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) –

    ContainerARN: The Amazon Resource Name (ARN) of the newly created 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

    ContainerName: The container name as specified in the request.

    CreationTime: Unix time stamp.

    Status: 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 an endpoint is available, the status changes to ACTIVE.

    The return value does not include the container’s endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

    • 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.ContainerInUseException

• MediaStore.Client.exceptions.LimitExceededException

• MediaStore.Client.exceptions.InternalServerError