openapi: 3.0.0
info:
version: 2017-09-01
x-release: v4
title: AWS Elemental MediaStore
description: "An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects. "
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediastore
x-aws-signingName: mediastore
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediastore-2017-09-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mediastore/
servers:
- url: http://mediastore.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaStore multi-region endpoint
- url: https://mediastore.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaStore multi-region endpoint
- url: http://mediastore.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaStore endpoint for China (Beijing) and China (Ningxia)
- url: https://mediastore.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaStore endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=MediaStore_20170901.CreateContainer:
post:
operationId: CreateContainer
description: Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateContainerOutput"
examples:
CreateContainer200Example:
summary: Default CreateContainer 200 response
x-microcks-default: true
value:
Container: example-value
"480":
description: ContainerInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerInUseException"
examples:
CreateContainer480Example:
summary: Default CreateContainer 480 response
x-microcks-default: true
value: {}
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
examples:
CreateContainer481Example:
summary: Default CreateContainer 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
CreateContainer482Example:
summary: Default CreateContainer 482 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateContainerInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- MediaStore_20170901.CreateContainer
summary: Amazon MediaStore Create Container
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=MediaStore_20170901.DeleteContainer:
post:
operationId: DeleteContainer
description: "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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteContainerOutput"
examples:
DeleteContainer200Example:
summary: Default DeleteContainer 200 response
x-microcks-default: true
value: {}
"480":
description: ContainerInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerInUseException"
examples:
DeleteContainer480Example:
summary: Default DeleteContainer 480 response
x-microcks-default: true
value: {}
"481":
description: ContainerNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerNotFoundException"
examples:
DeleteContainer481Example:
summary: Default DeleteContainer 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
DeleteContainer482Example:
summary: Default DeleteContainer 482 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteContainerInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- MediaStore_20170901.DeleteContainer
summary: Amazon MediaStore Delete Container
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=MediaStore_20170901.DeleteContainerPolicy:
post:
operationId: DeleteContainerPolicy
description: Deletes the access policy that is associated with the specified container.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteContainerPolicyOutput"
examples:
DeleteContainerPolicy200Example:
summary: Default DeleteContainerPolicy 200 response
x-microcks-default: true
value: {}
"480":
description: ContainerInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerInUseException"
examples:
DeleteContainerPolicy480Example:
summary: Default DeleteContainerPolicy 480 response
x-microcks-default: true
value: {}
"481":
description: ContainerNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerNotFoundException"
examples:
DeleteContainerPolicy481Example:
summary: Default DeleteContainerPolicy 481 response
x-microcks-default: true
value: {}
"482":
description: PolicyNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyNotFoundException"
examples:
DeleteContainerPolicy482Example:
summary: Default DeleteContainerPolicy 482 response
x-microcks-default: true
value: {}
"483":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
DeleteContainerPolicy483Example:
summary: Default DeleteContainerPolicy 483 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteContainerPolicyInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- MediaStore_20170901.DeleteContainerPolicy
summary: Amazon MediaStore Delete Container Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=MediaStore_20170901.DeleteCorsPolicy:
post:
operationId: DeleteCorsPolicy
description:
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.
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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeContainerOutput"
examples:
DescribeContainer200Example:
summary: Default DescribeContainer 200 response
x-microcks-default: true
value:
Container: example-value
"480":
description: ContainerNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerNotFoundException"
examples:
DescribeContainer480Example:
summary: Default DescribeContainer 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
DescribeContainer481Example:
summary: Default DescribeContainer 481 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeContainerInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- MediaStore_20170901.DescribeContainer
summary: Amazon MediaStore Describe Container
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=MediaStore_20170901.GetContainerPolicy:
post:
operationId: GetContainerPolicy
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetContainerPolicyOutput"
examples:
GetContainerPolicy200Example:
summary: Default GetContainerPolicy 200 response
x-microcks-default: true
value:
Policy: example-value
"480":
description: ContainerInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerInUseException"
examples:
GetContainerPolicy480Example:
summary: Default GetContainerPolicy 480 response
x-microcks-default: true
value: {}
"481":
description: ContainerNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerNotFoundException"
examples:
GetContainerPolicy481Example:
summary: Default GetContainerPolicy 481 response
x-microcks-default: true
value: {}
"482":
description: PolicyNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyNotFoundException"
examples:
GetContainerPolicy482Example:
summary: Default GetContainerPolicy 482 response
x-microcks-default: true
value: {}
"483":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
GetContainerPolicy483Example:
summary: Default GetContainerPolicy 483 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GetContainerPolicyInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- MediaStore_20170901.GetContainerPolicy
summary: Amazon MediaStore Get Container Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=MediaStore_20170901.GetCorsPolicy:
post:
operationId: GetCorsPolicy
description: 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.
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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListContainersOutput" examples: ListContainers200Example: summary: Default ListContainers 200 response x-microcks-default: true value: Containers: example-value NextToken: example-value "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListContainers480Example: summary: Default ListContainers 480 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListContainersInput" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.ListContainers summary: Amazon MediaStore List Containers x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.ListTagsForResource: post: operationId: ListTagsForResource description: "Returns a list of the tags assigned to the specified container. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceOutput" examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example-value "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.ListTagsForResource summary: Amazon MediaStore List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.PutContainerPolicy: post: operationId: PutContainerPolicy description: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.
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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutCorsPolicyOutput" examples: PutCorsPolicy200Example: summary: Default PutCorsPolicy 200 response x-microcks-default: true value: {} "480": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: PutCorsPolicy480Example: summary: Default PutCorsPolicy 480 response x-microcks-default: true value: {} "481": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: PutCorsPolicy481Example: summary: Default PutCorsPolicy 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: PutCorsPolicy482Example: summary: Default PutCorsPolicy 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutCorsPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.PutCorsPolicy summary: Amazon MediaStore Put Cors Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.PutLifecyclePolicy: post: operationId: PutLifecyclePolicy description: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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutLifecyclePolicyOutput" examples: PutLifecyclePolicy200Example: summary: Default PutLifecyclePolicy 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: PutLifecyclePolicy480Example: summary: Default PutLifecyclePolicy 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: PutLifecyclePolicy481Example: summary: Default PutLifecyclePolicy 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: PutLifecyclePolicy482Example: summary: Default PutLifecyclePolicy 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutLifecyclePolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.PutLifecyclePolicy summary: Amazon MediaStore Put Lifecycle Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.PutMetricPolicy: post: operationId: PutMetricPolicy description: The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutMetricPolicyOutput" examples: PutMetricPolicy200Example: summary: Default PutMetricPolicy 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: PutMetricPolicy480Example: summary: Default PutMetricPolicy 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: PutMetricPolicy481Example: summary: Default PutMetricPolicy 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: PutMetricPolicy482Example: summary: Default PutMetricPolicy 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutMetricPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.PutMetricPolicy summary: Amazon MediaStore Put Metric Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.StartAccessLogging: post: operationId: StartAccessLogging description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartAccessLoggingOutput" examples: StartAccessLogging200Example: summary: Default StartAccessLogging 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: StartAccessLogging480Example: summary: Default StartAccessLogging 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: StartAccessLogging481Example: summary: Default StartAccessLogging 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: StartAccessLogging482Example: summary: Default StartAccessLogging 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartAccessLoggingInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.StartAccessLogging summary: Amazon MediaStore Start Access Logging x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.StopAccessLogging: post: operationId: StopAccessLogging description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StopAccessLoggingOutput" examples: StopAccessLogging200Example: summary: Default StopAccessLogging 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: StopAccessLogging480Example: summary: Default StopAccessLogging 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: StopAccessLogging481Example: summary: Default StopAccessLogging 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: StopAccessLogging482Example: summary: Default StopAccessLogging 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StopAccessLoggingInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.StopAccessLogging summary: Amazon MediaStore Stop Access Logging x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.TagResource: post: operationId: TagResource description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TagResourceOutput" examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/TagResourceInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.TagResource summary: Amazon MediaStore Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=MediaStore_20170901.UntagResource: post: operationId: UntagResource description: "Removes tags from the specified container. You can specify one or more tags to remove. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceOutput" examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: {} "480": description: ContainerInUseException content: application/json: schema: $ref: "#/components/schemas/ContainerInUseException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: {} "481": description: ContainerNotFoundException content: application/json: schema: $ref: "#/components/schemas/ContainerNotFoundException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UntagResourceInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - MediaStore_20170901.UntagResource summary: Amazon MediaStore Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: CreateContainerOutput: type: object required: - Container properties: Container: allOf: - $ref: "#/components/schemas/Container" - description: "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.
" CreateContainerInput: type: object required: - ContainerName title: CreateContainerInput properties: ContainerName: allOf: - $ref: "#/components/schemas/ContainerName" - description: 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 namedmovies in every region, as long as you don’t have an existing container with that name.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: 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.
ContainerInUseException: {}
LimitExceededException: {}
InternalServerError: {}
DeleteContainerOutput:
type: object
properties: {}
DeleteContainerInput:
type: object
required:
- ContainerName
title: DeleteContainerInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: "The name of the container to delete. "
ContainerNotFoundException: {}
DeleteContainerPolicyOutput:
type: object
properties: {}
DeleteContainerPolicyInput:
type: object
required:
- ContainerName
title: DeleteContainerPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that holds the policy.
PolicyNotFoundException: {}
DeleteCorsPolicyOutput:
type: object
properties: {}
DeleteCorsPolicyInput:
type: object
required:
- ContainerName
title: DeleteCorsPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container to remove the policy from.
CorsPolicyNotFoundException: {}
DeleteLifecyclePolicyOutput:
type: object
properties: {}
DeleteLifecyclePolicyInput:
type: object
required:
- ContainerName
title: DeleteLifecyclePolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that holds the object lifecycle policy.
DeleteMetricPolicyOutput:
type: object
properties: {}
DeleteMetricPolicyInput:
type: object
required:
- ContainerName
title: DeleteMetricPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that is associated with the metric policy that you want to delete.
DescribeContainerOutput:
type: object
properties:
Container:
allOf:
- $ref: "#/components/schemas/Container"
- description: The name of the queried container.
DescribeContainerInput:
type: object
title: DescribeContainerInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container to query.
GetContainerPolicyOutput:
type: object
required:
- Policy
properties:
Policy:
allOf:
- $ref: "#/components/schemas/ContainerPolicy"
- description: The contents of the access policy.
GetContainerPolicyInput:
type: object
required:
- ContainerName
title: GetContainerPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: "The name of the container. "
GetCorsPolicyOutput:
type: object
required:
- CorsPolicy
properties:
CorsPolicy:
allOf:
- $ref: "#/components/schemas/CorsPolicy"
- description: The CORS policy assigned to the container.
GetCorsPolicyInput:
type: object
required:
- ContainerName
title: GetCorsPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that the policy is assigned to.
GetLifecyclePolicyOutput:
type: object
required:
- LifecyclePolicy
properties:
LifecyclePolicy:
allOf:
- $ref: "#/components/schemas/LifecyclePolicy"
- description: The object lifecycle policy that is assigned to the container.
GetLifecyclePolicyInput:
type: object
required:
- ContainerName
title: GetLifecyclePolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that the object lifecycle policy is assigned to.
GetMetricPolicyOutput:
type: object
required:
- MetricPolicy
properties:
MetricPolicy:
allOf:
- $ref: "#/components/schemas/MetricPolicy"
- description: The metric policy that is associated with the specific container.
GetMetricPolicyInput:
type: object
required:
- ContainerName
title: GetMetricPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container that is associated with the metric policy.
ListContainersOutput:
type: object
required:
- Containers
properties:
Containers:
allOf:
- $ref: "#/components/schemas/ContainerList"
- description: The names of the containers.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: " 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. "
ListContainersInput:
type: object
title: ListContainersInput
properties:
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: 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:
allOf:
- $ref: "#/components/schemas/ContainerListLimit"
- description: "Enter the maximum number of containers in the response. Use from 1 to 255 characters. "
ListTagsForResourceOutput:
type: object
properties:
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: An array of key:value pairs that are assigned to the container.
ListTagsForResourceInput:
type: object
required:
- Resource
title: ListTagsForResourceInput
properties:
Resource:
allOf:
- $ref: "#/components/schemas/ContainerARN"
- description: The Amazon Resource Name (ARN) for the container.
PutContainerPolicyOutput:
type: object
properties: {}
PutContainerPolicyInput:
type: object
required:
- ContainerName
- Policy
title: PutContainerPolicyInput
properties:
ContainerName:
allOf:
- $ref: "#/components/schemas/ContainerName"
- description: The name of the container.
Policy:
allOf:
- $ref: "#/components/schemas/ContainerPolicy"
- description: "The contents of the policy, which includes the following:
One Version tag
One Statement tag that contains the standard
tags for the policy.
The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:
An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.
An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).
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: allOf: - $ref: "#/components/schemas/ContainerName" - description: The name of the container. Status: allOf: - $ref: "#/components/schemas/ContainerStatus" - description: "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:
allOf:
- $ref: "#/components/schemas/ContainerAccessLoggingEnabled"
- description: 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.
description: This section describes operations that you can perform on an AWS Elemental MediaStore container.
ContainerLevelMetrics:
type: string
enum:
- ENABLED
- DISABLED
ContainerList:
type: array
items:
$ref: "#/components/schemas/Container"
ContainerListLimit:
type: integer
minimum: 1
maximum: 100
ContainerPolicy:
type: string
pattern: "[\\x00-\\x7F]+"
minLength: 1
maxLength: 8192
CorsRule:
type: object
required:
- AllowedOrigins
- AllowedHeaders
properties:
AllowedOrigins:
allOf:
- $ref: "#/components/schemas/AllowedOrigins"
- description: 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 (*).
MaxAgeSeconds: allOf: - $ref: "#/components/schemas/MaxAgeSeconds" - description: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.
description: 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. CorsPolicy: type: array description: "The CORS policy of the container. " items: $ref: "#/components/schemas/CorsRule" minItems: 1 maxItems: 100 MaxAgeSeconds: type: integer minimum: 0 maximum: 2147483647 ExposeHeaders: type: array items: $ref: "#/components/schemas/Header" minItems: 0 maxItems: 100 TagList: type: array items: $ref: "#/components/schemas/Tag" minItems: 1 maxItems: 200 LifecyclePolicy: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 0 maxLength: 8192 MetricPolicy: type: object required: - ContainerLevelMetrics properties: ContainerLevelMetrics: allOf: - $ref: "#/components/schemas/ContainerLevelMetrics" - description: A setting to enable or disable metrics at the container level. MetricPolicyRules: allOf: - $ref: "#/components/schemas/MetricPolicyRules" - description: A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy. description:The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.
To view examples of how to construct a metric policy for your use case, see Example Metric Policies.
PaginationToken: type: string pattern: "[0-9A-Za-z=/+]+" minLength: 1 maxLength: 1024 MetricPolicyRules: type: array items: $ref: "#/components/schemas/MetricPolicyRule" minItems: 1 maxItems: 300 ObjectGroup: type: string pattern: /?(?:[A-Za-z0-9_=:\.\-\~\*]+/){0,10}(?:[A-Za-z0-9_=:\.\-\~\*]+)?/? minLength: 1 maxLength: 900 ObjectGroupName: type: string pattern: "[a-zA-Z0-9_]+" minLength: 1 maxLength: 30 MetricPolicyRule: type: object required: - ObjectGroup - ObjectGroupName properties: ObjectGroup: allOf: - $ref: "#/components/schemas/ObjectGroup" - description: A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable. ObjectGroupName: allOf: - $ref: "#/components/schemas/ObjectGroupName" - description: A name that allows you to refer to the object group. description: A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also request a quota increase to allow up to 300 rules per policy. TagKey: type: string pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" minLength: 1 maxLength: 128 TagValue: type: string pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" minLength: 0 maxLength: 256 Tag: type: object required: - Key properties: Key: allOf: - $ref: "#/components/schemas/TagKey" - description: 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: allOf: - $ref: "#/components/schemas/TagValue" - description: 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. description: 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. TagKeyList: type: array items: $ref: "#/components/schemas/TagKey" security: - hmac: []