{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.mediastoredata#ContainerNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.mediastoredata#ErrorMessage" } }, "traits": { "smithy.api#documentation": "
The specified container was not found for the specified account.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.mediastoredata#ContentRangePattern": { "type": "string", "traits": { "smithy.api#pattern": "^bytes=\\d+\\-\\d+/\\d+$" } }, "com.amazonaws.mediastoredata#ContentType": { "type": "string", "traits": { "smithy.api#pattern": "^[\\w\\-\\/\\.\\+]{1,255}$" } }, "com.amazonaws.mediastoredata#DeleteObject": { "type": "operation", "input": { "target": "com.amazonaws.mediastoredata#DeleteObjectRequest" }, "output": { "target": "com.amazonaws.mediastoredata#DeleteObjectResponse" }, "errors": [ { "target": "com.amazonaws.mediastoredata#ContainerNotFoundException" }, { "target": "com.amazonaws.mediastoredata#InternalServerError" }, { "target": "com.amazonaws.mediastoredata#ObjectNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes an object at the specified path.
", "smithy.api#http": { "method": "DELETE", "uri": "/{Path+}", "code": 200 } } }, "com.amazonaws.mediastoredata#DeleteObjectRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.mediastoredata#PathNaming", "traits": { "smithy.api#documentation": "The path (including the file name) where the object is stored in the container.\n Format:
Gets the headers for an object at the specified path.
", "smithy.api#http": { "method": "HEAD", "uri": "/{Path+}", "code": 200 } } }, "com.amazonaws.mediastoredata#DescribeObjectRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.mediastoredata#PathNaming", "traits": { "smithy.api#documentation": "The path (including the file name) where the object is stored in the container.\n Format:
The ETag that represents a unique instance of the object.
", "smithy.api#httpHeader": "ETag" } }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { "smithy.api#documentation": "The content type of the object.
", "smithy.api#httpHeader": "Content-Type" } }, "ContentLength": { "target": "com.amazonaws.mediastoredata#NonNegativeLong", "traits": { "smithy.api#documentation": "The length of the object in bytes.
", "smithy.api#httpHeader": "Content-Length" } }, "CacheControl": { "target": "com.amazonaws.mediastoredata#StringPrimitive", "traits": { "smithy.api#documentation": "An optional CacheControl
header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
", "smithy.api#httpHeader": "Cache-Control" } }, "LastModified": { "target": "com.amazonaws.mediastoredata#TimeStamp", "traits": { "smithy.api#documentation": "The date and time that the object was last modified.
", "smithy.api#httpHeader": "Last-Modified" } } } }, "com.amazonaws.mediastoredata#ETag": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[0-9A-Fa-f]+" } }, "com.amazonaws.mediastoredata#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[ \\w:\\.\\?-]+" } }, "com.amazonaws.mediastoredata#GetObject": { "type": "operation", "input": { "target": "com.amazonaws.mediastoredata#GetObjectRequest" }, "output": { "target": "com.amazonaws.mediastoredata#GetObjectResponse" }, "errors": [ { "target": "com.amazonaws.mediastoredata#ContainerNotFoundException" }, { "target": "com.amazonaws.mediastoredata#InternalServerError" }, { "target": "com.amazonaws.mediastoredata#ObjectNotFoundException" }, { "target": "com.amazonaws.mediastoredata#RequestedRangeNotSatisfiableException" } ], "traits": { "smithy.api#documentation": "Downloads the object at the specified path. If the object’s upload availability is set to streaming
, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.
The path (including the file name) where the object is stored in the container.\n Format:
For example, to upload the file mlaw.avi
to the folder path\n premium\\canada
in the container movies
, enter the path\n premium/canada/mlaw.avi
.
Do not include the container name in this path.
\nIf the path includes any folders that don't exist yet, the service creates them. For\n example, suppose you have an existing premium/usa
subfolder. If you specify\n premium/canada
, the service creates a canada
subfolder in the\n premium
folder. You then have two subfolders, usa
and\n canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the\n container in AWS Elemental MediaStore.
\nFor more information about folders and how they exist in a container, see the AWS Elemental MediaStore User\n Guide.
\nThe file name is the name that is assigned to the file that you upload. The file can\n have the same name inside and outside of AWS Elemental MediaStore, or it can have the same\n name. The file name can include or omit an extension.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Range": { "target": "com.amazonaws.mediastoredata#RangePattern", "traits": { "smithy.api#documentation": "The range bytes of an object to retrieve. For more information about the\n Range
header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.
The bytes of the object.
", "smithy.api#httpPayload": {} } }, "CacheControl": { "target": "com.amazonaws.mediastoredata#StringPrimitive", "traits": { "smithy.api#documentation": "An optional CacheControl
header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
", "smithy.api#httpHeader": "Cache-Control" } }, "ContentRange": { "target": "com.amazonaws.mediastoredata#ContentRangePattern", "traits": { "smithy.api#documentation": "The range of bytes to retrieve.
", "smithy.api#httpHeader": "Content-Range" } }, "ContentLength": { "target": "com.amazonaws.mediastoredata#NonNegativeLong", "traits": { "smithy.api#documentation": "The length of the object in bytes.
", "smithy.api#httpHeader": "Content-Length" } }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { "smithy.api#documentation": "The content type of the object.
", "smithy.api#httpHeader": "Content-Type" } }, "ETag": { "target": "com.amazonaws.mediastoredata#ETag", "traits": { "smithy.api#documentation": "The ETag that represents a unique instance of the object.
", "smithy.api#httpHeader": "ETag" } }, "LastModified": { "target": "com.amazonaws.mediastoredata#TimeStamp", "traits": { "smithy.api#documentation": "The date and time that the object was last modified.
", "smithy.api#httpHeader": "Last-Modified" } }, "StatusCode": { "target": "com.amazonaws.mediastoredata#statusCode", "traits": { "smithy.api#documentation": "The HTML status code of the request. Status codes ranging from 200 to 299 indicate\n success. All other status codes indicate the type of error that occurred.
", "smithy.api#httpResponseCode": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediastoredata#InternalServerError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.mediastoredata#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The service is temporarily unavailable.
", "smithy.api#error": "server" } }, "com.amazonaws.mediastoredata#Item": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.mediastoredata#ItemName", "traits": { "smithy.api#documentation": "The name of the item.
" } }, "Type": { "target": "com.amazonaws.mediastoredata#ItemType", "traits": { "smithy.api#documentation": "The item type (folder or object).
" } }, "ETag": { "target": "com.amazonaws.mediastoredata#ETag", "traits": { "smithy.api#documentation": "The ETag that represents a unique instance of the item.
" } }, "LastModified": { "target": "com.amazonaws.mediastoredata#TimeStamp", "traits": { "smithy.api#documentation": "The date and time that the item was last modified.
" } }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { "smithy.api#documentation": "The content type of the item.
" } }, "ContentLength": { "target": "com.amazonaws.mediastoredata#NonNegativeLong", "traits": { "smithy.api#documentation": "The length of the item in bytes.
" } } }, "traits": { "smithy.api#documentation": "A metadata entry for a folder or object.
" } }, "com.amazonaws.mediastoredata#ItemList": { "type": "list", "member": { "target": "com.amazonaws.mediastoredata#Item" } }, "com.amazonaws.mediastoredata#ItemName": { "type": "string", "traits": { "smithy.api#pattern": "[A-Za-z0-9_\\.\\-\\~]+" } }, "com.amazonaws.mediastoredata#ItemType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OBJECT", "name": "OBJECT" }, { "value": "FOLDER", "name": "FOLDER" } ] } }, "com.amazonaws.mediastoredata#ListItems": { "type": "operation", "input": { "target": "com.amazonaws.mediastoredata#ListItemsRequest" }, "output": { "target": "com.amazonaws.mediastoredata#ListItemsResponse" }, "errors": [ { "target": "com.amazonaws.mediastoredata#ContainerNotFoundException" }, { "target": "com.amazonaws.mediastoredata#InternalServerError" } ], "traits": { "smithy.api#documentation": "Provides a list of metadata entries about folders and objects in the specified\n folder.
", "smithy.api#http": { "method": "GET", "uri": "/", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.mediastoredata#ListItemsRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.mediastoredata#ListPathNaming", "traits": { "smithy.api#documentation": "The path in the container from which to retrieve items. Format:
The maximum number of results to return per API request. For example, you submit a\n ListItems
request with MaxResults
set at 500. Although 2,000\n items match your request, the service returns no more than the first 500 items. (The\n service also returns a NextToken
value that you can use to fetch the next\n batch of results.) The service might return fewer results than the MaxResults
\n value.
If MaxResults
is not included in the request, the service defaults to\n pagination with a maximum of 1,000 results per page.
The token that identifies which batch of results that you want to see. For example,\n you submit a ListItems
request with MaxResults
set at 500. The\n service returns the first batch of results (up to 500) and a NextToken
value.\n To see the next batch of results, you can submit the ListItems
request a\n second time and specify the NextToken
value.
Tokens expire after 15 minutes.
", "smithy.api#httpQuery": "NextToken" } } } }, "com.amazonaws.mediastoredata#ListItemsResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediastoredata#ItemList", "traits": { "smithy.api#documentation": "The metadata entries for the folders and objects at the requested path.
" } }, "NextToken": { "target": "com.amazonaws.mediastoredata#PaginationToken", "traits": { "smithy.api#documentation": "The token that can be used in a request to view the next set of results. For example,\n you submit a ListItems
request that matches 2,000 items with\n MaxResults
set at 500. The service returns the first batch of results (up\n to 500) and a NextToken
value that can be used to fetch the next batch of\n results.
An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3\n service. Objects are the fundamental entities that are stored in AWS Elemental\n MediaStore.
", "smithy.api#title": "AWS Elemental MediaStore Data Plane", "smithy.api#xmlNamespace": { "uri": "https://object.mediastore.amazonaws.com/doc/2017-09-01" } } }, "com.amazonaws.mediastoredata#NonNegativeLong": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.mediastoredata#ObjectNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.mediastoredata#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Could not perform an operation on an object that does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.mediastoredata#PaginationToken": { "type": "string" }, "com.amazonaws.mediastoredata#PathNaming": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 900 }, "smithy.api#pattern": "(?:[A-Za-z0-9_\\.\\-\\~]+/){0,10}[A-Za-z0-9_\\.\\-\\~]+" } }, "com.amazonaws.mediastoredata#PayloadBlob": { "type": "blob", "traits": { "smithy.api#streaming": {} } }, "com.amazonaws.mediastoredata#PutObject": { "type": "operation", "input": { "target": "com.amazonaws.mediastoredata#PutObjectRequest" }, "output": { "target": "com.amazonaws.mediastoredata#PutObjectResponse" }, "errors": [ { "target": "com.amazonaws.mediastoredata#ContainerNotFoundException" }, { "target": "com.amazonaws.mediastoredata#InternalServerError" } ], "traits": { "aws.auth#unsignedPayload": {}, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.
", "smithy.api#http": { "method": "PUT", "uri": "/{Path+}", "code": 200 } } }, "com.amazonaws.mediastoredata#PutObjectRequest": { "type": "structure", "members": { "Body": { "target": "com.amazonaws.mediastoredata#PayloadBlob", "traits": { "smithy.api#documentation": "The bytes to be stored.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.mediastoredata#PathNaming", "traits": { "smithy.api#documentation": "The path (including the file name) where the object is stored in the container.\n Format:
For example, to upload the file mlaw.avi
to the folder path\n premium\\canada
in the container movies
, enter the path\n premium/canada/mlaw.avi
.
Do not include the container name in this path.
\nIf the path includes any folders that don't exist yet, the service creates them. For\n example, suppose you have an existing premium/usa
subfolder. If you specify\n premium/canada
, the service creates a canada
subfolder in the\n premium
folder. You then have two subfolders, usa
and\n canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the\n container in AWS Elemental MediaStore.
\nFor more information about folders and how they exist in a container, see the AWS Elemental MediaStore User\n Guide.
\nThe file name is the name that is assigned to the file that you upload. The file can\n have the same name inside and outside of AWS Elemental MediaStore, or it can have the same\n name. The file name can include or omit an extension.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { "smithy.api#documentation": "The content type of the object.
", "smithy.api#httpHeader": "Content-Type" } }, "CacheControl": { "target": "com.amazonaws.mediastoredata#StringPrimitive", "traits": { "smithy.api#documentation": "An optional CacheControl
header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
", "smithy.api#httpHeader": "Cache-Control" } }, "StorageClass": { "target": "com.amazonaws.mediastoredata#StorageClass", "traits": { "smithy.api#documentation": "Indicates the storage class of a Put
request. Defaults to\n high-performance temporal storage class, and objects are persisted into durable storage\n shortly after being received.
Indicates the availability of an object while it is still uploading. If the value is set to streaming
, the object is available for\n downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard
, the object is\n available for downloading only when it is uploaded completely. The default value for this header is standard
.
To use this header, you must also set the HTTP Transfer-Encoding
header to chunked
.
The SHA256 digest of the object that is persisted.
" } }, "ETag": { "target": "com.amazonaws.mediastoredata#ETag", "traits": { "smithy.api#documentation": "Unique identifier of the object in the container.
" } }, "StorageClass": { "target": "com.amazonaws.mediastoredata#StorageClass", "traits": { "smithy.api#documentation": "The storage class where the object was persisted. The class should be\n “Temporal”.
" } } } }, "com.amazonaws.mediastoredata#RangePattern": { "type": "string", "traits": { "smithy.api#pattern": "^bytes=(?:\\d+\\-\\d*|\\d*\\-\\d+)$" } }, "com.amazonaws.mediastoredata#RequestedRangeNotSatisfiableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.mediastoredata#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The requested content range is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 416 } }, "com.amazonaws.mediastoredata#SHA256Hash": { "type": "string", "traits": { "smithy.api#length": { "min": 64, "max": 64 }, "smithy.api#pattern": "[0-9A-Fa-f]{64}" } }, "com.amazonaws.mediastoredata#StorageClass": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TEMPORAL", "name": "TEMPORAL" } ], "smithy.api#length": { "min": 1, "max": 16 } } }, "com.amazonaws.mediastoredata#StringPrimitive": { "type": "string" }, "com.amazonaws.mediastoredata#TimeStamp": { "type": "timestamp" }, "com.amazonaws.mediastoredata#UploadAvailability": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STANDARD", "name": "STANDARD" }, { "value": "STREAMING", "name": "STREAMING" } ], "smithy.api#length": { "min": 1, "max": 16 } } }, "com.amazonaws.mediastoredata#statusCode": { "type": "integer" } } }