MediaStore / Client / list_containers

list_containers#

MediaStore.Client.list_containers(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_containers(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – 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.

  • MaxResults (integer) – Enter the maximum number of containers in the response. Use from 1 to 255 characters.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Containers (list) –

      The names of the containers.

      • (dict) –

        This section describes operations that you can perform on an AWS Elemental MediaStore 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.

    • NextToken (string) –

      NextToken is the token to use in the next call to ListContainers. This token is returned only if you included the MaxResults tag in the original command, and only if there are still containers to return.

Exceptions