2017/11/27 - AWS Elemental MediaStore - 7 new api methods
Changes Update mediastore client to latest version
Retrieves the properties of the requested container. This 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'
)
string
The name of the container to query.
dict
Response Syntax
{
'Container': {
'Endpoint': 'string',
'CreationTime': datetime(2015, 1, 1),
'ARN': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'CREATING'|'DELETING'
}
}
Response Structure
(dict) --
Container (dict) --
The name of the queried container.
Endpoint (string) --
The DNS endpoint of the container. Use from 1 to 255 characters. Use this endpoint to identify this container when sending requests to the data plane.
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.
Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
See also: AWS API Documentation
Request Syntax
client.get_container_policy(
ContainerName='string'
)
string
[REQUIRED]
The name of the container.
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
(dict) --
Policy (string) --
The contents of the access policy.
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'
)
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.
dict
Response Syntax
{
'Container': {
'Endpoint': 'string',
'CreationTime': datetime(2015, 1, 1),
'ARN': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'CREATING'|'DELETING'
}
}
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 timestamp.
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 from 1 to 255 characters. Use this endpoint to identify this container when sending requests to the data plane.
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.
Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers.
See also: AWS API Documentation
Request Syntax
client.delete_container(
ContainerName='string'
)
string
[REQUIRED]
The name of the container to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.
See also: AWS API Documentation
Request Syntax
client.put_container_policy(
ContainerName='string',
Policy='string'
)
string
[REQUIRED]
The name of the container.
string
[REQUIRED]
The contents of the policy, which includes the following:
One Version tag
One Statement tag that contains the standard tags for the policy.
dict
Response Syntax
{}
Response Structure
(dict) --
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
)
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.
integer
Enter the maximum number of containers in the response. Use from 1 to 255 characters.
dict
Response Syntax
{
'Containers': [
{
'Endpoint': 'string',
'CreationTime': datetime(2015, 1, 1),
'ARN': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'CREATING'|'DELETING'
},
],
'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 from 1 to 255 characters. Use this endpoint to identify this container when sending requests to the data plane.
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.
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.
Deletes the access policy that is associated with the specified container.
See also: AWS API Documentation
Request Syntax
client.delete_container_policy(
ContainerName='string'
)
string
[REQUIRED]
The name of the container that holds the policy.
dict
Response Syntax
{}
Response Structure
(dict) --