Table of Contents
A low-level client representing AWS Elemental MediaStore:
import boto3
client = boto3.client('mediastore')
These are the available methods:
Check if an operation can be paginated.
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'
},
]
)
[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.
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 .
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 .
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.
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.
dict
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.
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
response = client.delete_container(
ContainerName='string'
)
[REQUIRED]
The name of the container to delete.
{}
Response Structure
Deletes the access policy that is associated with the specified container.
See also: AWS API Documentation
Request Syntax
response = client.delete_container_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container that holds the policy.
{}
Response Structure
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others.
See also: AWS API Documentation
Request Syntax
response = client.delete_cors_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container to remove the policy from.
{}
Response Structure
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
See also: AWS API Documentation
Request Syntax
response = client.delete_lifecycle_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container that holds the object lifecycle policy.
{}
Response Structure
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'
)
{
'Container': {
'Endpoint': 'string',
'CreationTime': datetime(2015, 1, 1),
'ARN': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'CREATING'|'DELETING',
'AccessLoggingEnabled': True|False
}
}
Response Structure
The name of the queried container.
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.
Unix timestamp.
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
The name of the container.
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 .
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.
Generate a presigned url given a client, its method, and arguments
The presigned url
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
response = client.get_container_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container.
{
'Policy': 'string'
}
Response Structure
The contents of the access policy.
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others.
See also: AWS API Documentation
Request Syntax
response = client.get_cors_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container that the policy is assigned to.
{
'CorsPolicy': [
{
'AllowedOrigins': [
'string',
],
'AllowedMethods': [
'PUT'|'GET'|'DELETE'|'HEAD',
],
'AllowedHeaders': [
'string',
],
'MaxAgeSeconds': 123,
'ExposeHeaders': [
'string',
]
},
]
}
Response Structure
The CORS policy assigned to the container.
A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.
Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.
Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.
This element can contain only one wildcard character (*).
The time in seconds that your browser caches the preflight response for the specified resource.
A CORS rule can have only one MaxAgeSeconds element.
One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
This element is optional for each rule.
Retrieves the object lifecycle policy that is assigned to a container.
See also: AWS API Documentation
Request Syntax
response = client.get_lifecycle_policy(
ContainerName='string'
)
[REQUIRED]
The name of the container that the object lifecycle policy is assigned to.
{
'LifecyclePolicy': 'string'
}
Response Structure
The object lifecycle policy that is assigned to the container.
Create a paginator for an operation.
Returns an object that can wait for some condition.
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
)
dict
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.
Returns a list of the tags assigned to the specified container.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
Resource='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the container.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
An array of key:value pairs that are assigned to the container.
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 .
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.
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.
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
response = client.put_container_policy(
ContainerName='string',
Policy='string'
)
[REQUIRED]
The name of the container.
[REQUIRED]
The contents of the policy, which includes the following:
dict
Response Syntax
{}
Response Structure
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.
To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore .
See also: AWS API Documentation
Request Syntax
response = client.put_cors_policy(
ContainerName='string',
CorsPolicy=[
{
'AllowedOrigins': [
'string',
],
'AllowedMethods': [
'PUT'|'GET'|'DELETE'|'HEAD',
],
'AllowedHeaders': [
'string',
],
'MaxAgeSeconds': 123,
'ExposeHeaders': [
'string',
]
},
]
)
[REQUIRED]
The name of the container that you want to assign the CORS policy to.
[REQUIRED]
The CORS policy to apply to the container.
A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.
Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.
Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.
This element can contain only one wildcard character (*).
The time in seconds that your browser caches the preflight response for the specified resource.
A CORS rule can have only one MaxAgeSeconds element.
One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
This element is optional for each rule.
dict
Response Syntax
{}
Response Structure
Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy .
See also: AWS API Documentation
Request Syntax
response = client.put_lifecycle_policy(
ContainerName='string',
LifecyclePolicy='string'
)
[REQUIRED]
The name of the container that you want to assign the object lifecycle policy to.
[REQUIRED]
The object lifecycle policy to apply to the container.
dict
Response Syntax
{}
Response Structure
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
response = client.start_access_logging(
ContainerName='string'
)
[REQUIRED]
The name of the container that you want to start access logging on.
{}
Response Structure
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
response = client.stop_access_logging(
ContainerName='string'
)
[REQUIRED]
The name of the container that you want to stop access logging on.
{}
Response Structure
Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. 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 .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Resource='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the container.
[REQUIRED]
An array of key:value pairs that you want to add to the container. You need to specify only the tags that you want to add or update. For example, suppose a container already has two tags (customer:CompanyA and priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource, you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags: customer:CompanyA, priority:Medium, and type:Contract.
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 .
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.
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.
dict
Response Syntax
{}
Response Structure
Removes tags from the specified container. You can specify one or more tags to remove.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Resource='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the container.
[REQUIRED]
A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove (priority).
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_containers')
Creates an iterator that will paginate through responses from MediaStore.Client.list_containers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Containers': [
{
'Endpoint': 'string',
'CreationTime': datetime(2015, 1, 1),
'ARN': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'CREATING'|'DELETING',
'AccessLoggingEnabled': True|False
},
],
}
Response Structure
The names of the containers.
This section describes operations that you can perform on an AWS Elemental MediaStore container.
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.
Unix timestamp.
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
The name of the container.
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 .
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.