AWS Elemental MediaStore

Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.

See also: AWS API Documentation

Request Syntax

client.start_access_logging(
    ContainerName='string'
)

type ContainerName

string

param ContainerName

[REQUIRED]

The name of the container that you want to start access logging on.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.

See also: AWS API Documentation

Request Syntax

client.stop_access_logging(
    ContainerName='string'
)

type ContainerName

string

param ContainerName

[REQUIRED]

The name of the container that you want to stop access logging on.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'Container': {'AccessLoggingEnabled': 'boolean'}}

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

client.create_container(
    ContainerName='string'
)

type ContainerName

string

param ContainerName

[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.

rtype

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.

{'Container': {'AccessLoggingEnabled': 'boolean'}}

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

client.describe_container(
    ContainerName='string'
)

type ContainerName

string

param ContainerName

The name of the container to query.

rtype

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.

{'Containers': {'AccessLoggingEnabled': 'boolean'}}

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

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

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

Enter the maximum number of containers in the response. Use from 1 to 255 characters.

rtype

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.