The #X Amz Target=MediaStore 20170901.DescribeContainer API from Amazon MediaStore — 1 operation(s) for #x amz target=mediastore 20170901.describecontainer.
openapi: 3.0.0
info:
version: 2017-09-01
x-release: v4
title: 'AWS Elemental MediaStore #X Amz Target=MediaStore 20170901.CreateContainer #X Amz Target=MediaStore 20170901.CreateContainer #X Amz Target=MediaStore 20170901.DescribeContainer API'
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
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)
security:
- hmac: []
tags:
- name: '#X Amz Target=MediaStore 20170901.DescribeContainer'
paths:
/#X-Amz-Target=MediaStore_20170901.DescribeContainer:
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'
post:
operationId: DescribeContainer
description: 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>.
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
tags:
- '#X Amz Target=MediaStore 20170901.DescribeContainer'
components:
schemas:
ContainerARN:
type: string
pattern: arn:aws:mediastore:[a-z]+-[a-z]+-\d:\d{12}:container/[\w-]{1,255}
minLength: 1
maxLength: 1024
ContainerAccessLoggingEnabled:
type: boolean
ContainerNotFoundException: {}
ContainerName:
type: string
pattern: '[\w-]+'
minLength: 1
maxLength: 255
Container:
type: object
properties:
Endpoint:
allOf:
- $ref: '#/components/schemas/Endpoint'
- description: 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:
allOf:
- $ref: '#/components/schemas/TimeStamp'
- description: Unix timestamp.
ARN:
allOf:
- $ref: '#/components/schemas/ContainerARN'
- description: '<p>The Amazon Resource Name (ARN) of the container. The ARN has the following format:</p> <p>arn:aws:<region>:<account that owns this container>:container/<name of container> </p> <p>For example: arn:aws:mediastore:us-west-2:111122223333:container/movies </p>'
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: <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>.'
AccessLoggingEnabled:
allOf:
- $ref: '#/components/schemas/ContainerAccessLoggingEnabled'
- description: The state of access logging on the container. This value is <code>false</code> 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 <code>true</code>, 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.
TimeStamp:
type: string
format: date-time
ContainerStatus:
type: string
enum:
- ACTIVE
- CREATING
- DELETING
minLength: 1
maxLength: 16
DescribeContainerInput:
type: object
title: DescribeContainerInput
properties:
ContainerName:
allOf:
- $ref: '#/components/schemas/ContainerName'
- description: The name of the container to query.
Endpoint:
type: string
pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+'
minLength: 1
maxLength: 255
InternalServerError: {}
DescribeContainerOutput:
type: object
properties:
Container:
allOf:
- $ref: '#/components/schemas/Container'
- description: The name of the queried container.
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mediastore/
x-hasEquivalentPaths: true