python-botocore/botocore/data/mediastore/2017-09-01/service-2.json
2018-02-11 17:52:35 +09:00

571 lines
22 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2017-09-01",
"endpointPrefix":"mediastore",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"MediaStore",
"serviceFullName":"AWS Elemental MediaStore",
"serviceId":"MediaStore",
"signatureVersion":"v4",
"signingName":"mediastore",
"targetPrefix":"MediaStore_20170901",
"uid":"mediastore-2017-09-01"
},
"operations":{
"CreateContainer":{
"name":"CreateContainer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateContainerInput"},
"output":{"shape":"CreateContainerOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.</p>"
},
"DeleteContainer":{
"name":"DeleteContainer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteContainerInput"},
"output":{"shape":"DeleteContainerOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the specified container. Before you make a <code>DeleteContainer</code> request, delete any objects in the container or in any folders in the container. You can delete only empty containers. </p>"
},
"DeleteContainerPolicy":{
"name":"DeleteContainerPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteContainerPolicyInput"},
"output":{"shape":"DeleteContainerPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"PolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the access policy that is associated with the specified container.</p>"
},
"DeleteCorsPolicy":{
"name":"DeleteCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCorsPolicyInput"},
"output":{"shape":"DeleteCorsPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"CorsPolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.</p> <p>To use this operation, you must have permission to perform the <code>MediaStore:DeleteCorsPolicy</code> action. The container owner has this permission by default and can grant this permission to others.</p>"
},
"DescribeContainer":{
"name":"DescribeContainer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeContainerInput"},
"output":{"shape":"DescribeContainerOutput"},
"errors":[
{"shape":"ContainerNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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 <code>DescribeContainer</code> request returns a single <code>Container</code> object based on <code>ContainerName</code>. To return all <code>Container</code> objects that are associated with a specified AWS account, use <a>ListContainers</a>.</p>"
},
"GetContainerPolicy":{
"name":"GetContainerPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetContainerPolicyInput"},
"output":{"shape":"GetContainerPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"PolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the <a href=\"https://aws.amazon.com/documentation/iam/\">AWS Identity and Access Management User Guide</a>.</p>"
},
"GetCorsPolicy":{
"name":"GetCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCorsPolicyInput"},
"output":{"shape":"GetCorsPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"CorsPolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.</p> <p>To use this operation, you must have permission to perform the <code>MediaStore:GetCorsPolicy</code> action. By default, the container owner has this permission and can grant it to others.</p>"
},
"ListContainers":{
"name":"ListContainers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListContainersInput"},
"output":{"shape":"ListContainersOutput"},
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists the properties of all containers in AWS Elemental MediaStore. </p> <p>You can query to receive all the containers in one response. Or you can include the <code>MaxResults</code> 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 <code>NextToken</code> 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. </p> <p>See also <a>DescribeContainer</a>, which gets the properties of one container. </p>"
},
"PutContainerPolicy":{
"name":"PutContainerPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutContainerPolicyInput"},
"output":{"shape":"PutContainerPolicyOutput"},
"errors":[
{"shape":"ContainerNotFoundException"},
{"shape":"ContainerInUseException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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 <a href=\"https://aws.amazon.com/documentation/iam/\">AWS Identity and Access Management User Guide</a>.</p> <p>For this release of the REST API, you can create only one policy for a container. If you enter <code>PutContainerPolicy</code> twice, the second command modifies the existing policy. </p>"
},
"PutCorsPolicy":{
"name":"PutCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutCorsPolicyInput"},
"output":{"shape":"PutCorsPolicyOutput"},
"errors":[
{"shape":"ContainerNotFoundException"},
{"shape":"ContainerInUseException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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.</p> <p>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.</p>"
}
},
"shapes":{
"AllowedHeaders":{
"type":"list",
"member":{"shape":"Header"},
"max":100,
"min":0
},
"AllowedMethods":{
"type":"list",
"member":{"shape":"MethodName"}
},
"AllowedOrigins":{
"type":"list",
"member":{"shape":"Origin"}
},
"Container":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"Endpoint",
"documentation":"<p>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.</p>"
},
"CreationTime":{
"shape":"TimeStamp",
"documentation":"<p>Unix timestamp.</p>"
},
"ARN":{
"shape":"ContainerARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the container. The ARN has the following format:</p> <p>arn:aws:&lt;region&gt;:&lt;account that owns this container&gt;:container/&lt;name of container&gt; </p> <p>For example: arn:aws:mediastore:us-west-2:111122223333:container/movies </p>"
},
"Name":{
"shape":"ContainerName",
"documentation":"<p>The name of the container.</p>"
},
"Status":{
"shape":"ContainerStatus",
"documentation":"<p>The status of container creation or deletion. The status is one of the following: <code>CREATING</code>, <code>ACTIVE</code>, or <code>DELETING</code>. While the service is creating the container, the status is <code>CREATING</code>. When the endpoint is available, the status changes to <code>ACTIVE</code>.</p>"
}
},
"documentation":"<p>This section describes operations that you can perform on an AWS Elemental MediaStore container.</p>"
},
"ContainerARN":{
"type":"string",
"max":1024,
"min":1,
"pattern":"arn:aws:mediastore:[a-z]+-[a-z]+-\\d:\\d{12}:container/\\w{1,255}"
},
"ContainerInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Resource already exists or is being updated.</p>",
"exception":true
},
"ContainerList":{
"type":"list",
"member":{"shape":"Container"}
},
"ContainerListLimit":{
"type":"integer",
"max":100,
"min":1
},
"ContainerName":{
"type":"string",
"max":255,
"min":1,
"pattern":"\\w+"
},
"ContainerNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Could not perform an operation on a container that does not exist.</p>",
"exception":true
},
"ContainerPolicy":{
"type":"string",
"max":8192,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"ContainerStatus":{
"type":"string",
"enum":[
"ACTIVE",
"CREATING",
"DELETING"
],
"max":16,
"min":1
},
"CorsPolicy":{
"type":"list",
"member":{"shape":"CorsRule"},
"documentation":"<p>The CORS policy of the container. </p>",
"max":100,
"min":1
},
"CorsPolicyNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Could not perform an operation on a policy that does not exist.</p>",
"exception":true
},
"CorsRule":{
"type":"structure",
"members":{
"AllowedOrigins":{
"shape":"AllowedOrigins",
"documentation":"<p>One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript <code>XMLHttpRequest</code> object).</p> <p>Each CORS rule must have at least one <code>AllowedOrigin</code> 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.</p>"
},
"AllowedMethods":{
"shape":"AllowedMethods",
"documentation":"<p>Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.</p> <p>Each CORS rule must contain at least one <code>AllowedMethod</code> and one <code>AllowedOrigin</code> element.</p>"
},
"AllowedHeaders":{
"shape":"AllowedHeaders",
"documentation":"<p>Specifies which headers are allowed in a preflight <code>OPTIONS</code> request through the <code>Access-Control-Request-Headers</code> header. Each header name that is specified in <code>Access-Control-Request-Headers</code> must have a corresponding entry in the rule. Only the headers that were requested are sent back. </p> <p>This element can contain only one wildcard character (*).</p>"
},
"MaxAgeSeconds":{
"shape":"MaxAgeSeconds",
"documentation":"<p>The time in seconds that your browser caches the preflight response for the specified resource.</p> <p>A CORS rule can have only one <code>MaxAgeSeconds</code> element.</p>"
},
"ExposeHeaders":{
"shape":"ExposeHeaders",
"documentation":"<p>One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript <code>XMLHttpRequest</code> object).</p> <p>This element is optional for each rule.</p>"
}
},
"documentation":"<p>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.</p>"
},
"CreateContainerInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>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 <code>movies</code> in every region, as long as you dont have an existing container with that name.</p>"
}
}
},
"CreateContainerOutput":{
"type":"structure",
"required":["Container"],
"members":{
"Container":{
"shape":"Container",
"documentation":"<p>ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:&lt;region&gt;:&lt;account that owns this container&gt;:container/&lt;name of container&gt;. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies </p> <p>ContainerName: The container name as specified in the request.</p> <p>CreationTime: Unix time stamp.</p> <p>Status: The status of container creation or deletion. The status is one of the following: <code>CREATING</code>, <code>ACTIVE</code>, or <code>DELETING</code>. While the service is creating the container, the status is <code>CREATING</code>. When an endpoint is available, the status changes to <code>ACTIVE</code>.</p> <p>The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using <a>DescribeContainer</a> or <a>ListContainers</a>.</p>"
}
}
},
"DeleteContainerInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container to delete. </p>"
}
}
},
"DeleteContainerOutput":{
"type":"structure",
"members":{
}
},
"DeleteContainerPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that holds the policy.</p>"
}
}
},
"DeleteContainerPolicyOutput":{
"type":"structure",
"members":{
}
},
"DeleteCorsPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container to remove the policy from.</p>"
}
}
},
"DeleteCorsPolicyOutput":{
"type":"structure",
"members":{
}
},
"DescribeContainerInput":{
"type":"structure",
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container to query.</p>"
}
}
},
"DescribeContainerOutput":{
"type":"structure",
"members":{
"Container":{
"shape":"Container",
"documentation":"<p>The name of the queried container.</p>"
}
}
},
"Endpoint":{
"type":"string",
"max":255,
"min":1
},
"ErrorMessage":{
"type":"string",
"max":255,
"min":1,
"pattern":"[ \\w:\\.\\?-]+"
},
"ExposeHeaders":{
"type":"list",
"member":{"shape":"Header"},
"max":100,
"min":0
},
"GetContainerPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container. </p>"
}
}
},
"GetContainerPolicyOutput":{
"type":"structure",
"required":["Policy"],
"members":{
"Policy":{
"shape":"ContainerPolicy",
"documentation":"<p>The contents of the access policy.</p>"
}
}
},
"GetCorsPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that the policy is assigned to.</p>"
}
}
},
"GetCorsPolicyOutput":{
"type":"structure",
"required":["CorsPolicy"],
"members":{
"CorsPolicy":{"shape":"CorsPolicy"}
}
},
"Header":{
"type":"string",
"max":8192,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"InternalServerError":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The service is temporarily unavailable.</p>",
"exception":true,
"fault":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>A service limit has been exceeded.</p>",
"exception":true
},
"ListContainersInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>Only if you used <code>MaxResults</code> 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.</p>"
},
"MaxResults":{
"shape":"ContainerListLimit",
"documentation":"<p>Enter the maximum number of containers in the response. Use from 1 to 255 characters. </p>"
}
}
},
"ListContainersOutput":{
"type":"structure",
"required":["Containers"],
"members":{
"Containers":{
"shape":"ContainerList",
"documentation":"<p>The names of the containers.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p> <code>NextToken</code> is the token to use in the next call to <code>ListContainers</code>. This token is returned only if you included the <code>MaxResults</code> tag in the original command, and only if there are still containers to return. </p>"
}
}
},
"MaxAgeSeconds":{
"type":"integer",
"max":2147483647,
"min":0
},
"MethodName":{
"type":"string",
"enum":[
"PUT",
"GET",
"DELETE",
"HEAD"
]
},
"Origin":{
"type":"string",
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"PaginationToken":{
"type":"string",
"max":255,
"min":1,
"pattern":"[0-9A-Za-z=/+]+"
},
"PolicyNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Could not perform an operation on a policy that does not exist.</p>",
"exception":true
},
"PutContainerPolicyInput":{
"type":"structure",
"required":[
"ContainerName",
"Policy"
],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container.</p>"
},
"Policy":{
"shape":"ContainerPolicy",
"documentation":"<p>The contents of the policy, which includes the following: </p> <ul> <li> <p>One <code>Version</code> tag</p> </li> <li> <p>One <code>Statement</code> tag that contains the standard tags for the policy.</p> </li> </ul>"
}
}
},
"PutContainerPolicyOutput":{
"type":"structure",
"members":{
}
},
"PutCorsPolicyInput":{
"type":"structure",
"required":[
"ContainerName",
"CorsPolicy"
],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that you want to assign the CORS policy to.</p>"
},
"CorsPolicy":{
"shape":"CorsPolicy",
"documentation":"<p>The CORS policy to apply to the container. </p>"
}
}
},
"PutCorsPolicyOutput":{
"type":"structure",
"members":{
}
},
"TimeStamp":{"type":"timestamp"}
},
"documentation":"<p>An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects. </p>"
}