Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- putObject_storageClass :: Lens' PutObject (Maybe StorageClass)
- putObject_uploadAvailability :: Lens' PutObject (Maybe UploadAvailability)
- putObject_cacheControl :: Lens' PutObject (Maybe Text)
- putObject_contentType :: Lens' PutObject (Maybe Text)
- putObject_path :: Lens' PutObject Text
- putObject_body :: Lens' PutObject HashedBody
- putObjectResponse_eTag :: Lens' PutObjectResponse (Maybe Text)
- putObjectResponse_storageClass :: Lens' PutObjectResponse (Maybe StorageClass)
- putObjectResponse_contentSHA256 :: Lens' PutObjectResponse (Maybe Text)
- putObjectResponse_httpStatus :: Lens' PutObjectResponse Int
- deleteObject_path :: Lens' DeleteObject Text
- deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int
- describeObject_path :: Lens' DescribeObject Text
- describeObjectResponse_eTag :: Lens' DescribeObjectResponse (Maybe Text)
- describeObjectResponse_contentLength :: Lens' DescribeObjectResponse (Maybe Natural)
- describeObjectResponse_cacheControl :: Lens' DescribeObjectResponse (Maybe Text)
- describeObjectResponse_lastModified :: Lens' DescribeObjectResponse (Maybe UTCTime)
- describeObjectResponse_contentType :: Lens' DescribeObjectResponse (Maybe Text)
- describeObjectResponse_httpStatus :: Lens' DescribeObjectResponse Int
- getObject_range :: Lens' GetObject (Maybe Text)
- getObject_path :: Lens' GetObject Text
- getObjectResponse_eTag :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentLength :: Lens' GetObjectResponse (Maybe Natural)
- getObjectResponse_cacheControl :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_lastModified :: Lens' GetObjectResponse (Maybe UTCTime)
- getObjectResponse_contentRange :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentType :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_statusCode :: Lens' GetObjectResponse Int
- getObjectResponse_body :: Lens' GetObjectResponse ResponseBody
- listItems_path :: Lens' ListItems (Maybe Text)
- listItems_nextToken :: Lens' ListItems (Maybe Text)
- listItems_maxResults :: Lens' ListItems (Maybe Natural)
- listItemsResponse_items :: Lens' ListItemsResponse (Maybe [Item])
- listItemsResponse_nextToken :: Lens' ListItemsResponse (Maybe Text)
- listItemsResponse_httpStatus :: Lens' ListItemsResponse Int
- item_eTag :: Lens' Item (Maybe Text)
- item_contentLength :: Lens' Item (Maybe Natural)
- item_name :: Lens' Item (Maybe Text)
- item_type :: Lens' Item (Maybe ItemType)
- item_lastModified :: Lens' Item (Maybe UTCTime)
- item_contentType :: Lens' Item (Maybe Text)
Operations
PutObject
putObject_storageClass :: Lens' PutObject (Maybe StorageClass) Source #
Indicates the storage class of a Put
request. Defaults to
high-performance temporal storage class, and objects are persisted into
durable storage shortly after being received.
putObject_uploadAvailability :: Lens' PutObject (Maybe UploadAvailability) Source #
Indicates the availability of an object while it is still uploading. If
the value is set to streaming
, the object is available for downloading
after some initial buffering but before the object is uploaded
completely. If the value is set to standard
, the object is 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
.
putObject_cacheControl :: Lens' PutObject (Maybe Text) Source #
An optional CacheControl
header that allows the caller to control the
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.
putObject_path :: Lens' PutObject Text Source #
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
For example, to upload the file mlaw.avi
to the folder path
premium\canada
in the container movies
, enter the path
premium/canada/mlaw.avi
.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service
creates them. For example, suppose you have an existing premium/usa
subfolder. If you specify premium/canada
, the service creates a
canada
subfolder in the premium
folder. You then have two
subfolders, usa
and canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
putObject_body :: Lens' PutObject HashedBody Source #
The bytes to be stored.
putObjectResponse_eTag :: Lens' PutObjectResponse (Maybe Text) Source #
Unique identifier of the object in the container.
putObjectResponse_storageClass :: Lens' PutObjectResponse (Maybe StorageClass) Source #
The storage class where the object was persisted. The class should be “Temporal”.
putObjectResponse_contentSHA256 :: Lens' PutObjectResponse (Maybe Text) Source #
The SHA256 digest of the object that is persisted.
putObjectResponse_httpStatus :: Lens' PutObjectResponse Int Source #
The response's http status code.
DeleteObject
deleteObject_path :: Lens' DeleteObject Text Source #
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int Source #
The response's http status code.
DescribeObject
describeObject_path :: Lens' DescribeObject Text Source #
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
describeObjectResponse_eTag :: Lens' DescribeObjectResponse (Maybe Text) Source #
The ETag that represents a unique instance of the object.
describeObjectResponse_contentLength :: Lens' DescribeObjectResponse (Maybe Natural) Source #
The length of the object in bytes.
describeObjectResponse_cacheControl :: Lens' DescribeObjectResponse (Maybe Text) Source #
An optional CacheControl
header that allows the caller to control the
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.
describeObjectResponse_lastModified :: Lens' DescribeObjectResponse (Maybe UTCTime) Source #
The date and time that the object was last modified.
describeObjectResponse_contentType :: Lens' DescribeObjectResponse (Maybe Text) Source #
The content type of the object.
describeObjectResponse_httpStatus :: Lens' DescribeObjectResponse Int Source #
The response's http status code.
GetObject
getObject_range :: Lens' GetObject (Maybe Text) Source #
The range bytes of an object to retrieve. For more information about the
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.
getObject_path :: Lens' GetObject Text Source #
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
For example, to upload the file mlaw.avi
to the folder path
premium\canada
in the container movies
, enter the path
premium/canada/mlaw.avi
.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service
creates them. For example, suppose you have an existing premium/usa
subfolder. If you specify premium/canada
, the service creates a
canada
subfolder in the premium
folder. You then have two
subfolders, usa
and canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
getObjectResponse_eTag :: Lens' GetObjectResponse (Maybe Text) Source #
The ETag that represents a unique instance of the object.
getObjectResponse_contentLength :: Lens' GetObjectResponse (Maybe Natural) Source #
The length of the object in bytes.
getObjectResponse_cacheControl :: Lens' GetObjectResponse (Maybe Text) Source #
An optional CacheControl
header that allows the caller to control the
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.
getObjectResponse_lastModified :: Lens' GetObjectResponse (Maybe UTCTime) Source #
The date and time that the object was last modified.
getObjectResponse_contentRange :: Lens' GetObjectResponse (Maybe Text) Source #
The range of bytes to retrieve.
getObjectResponse_contentType :: Lens' GetObjectResponse (Maybe Text) Source #
The content type of the object.
getObjectResponse_statusCode :: Lens' GetObjectResponse Int Source #
The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.
getObjectResponse_body :: Lens' GetObjectResponse ResponseBody Source #
The bytes of the object.
ListItems
listItems_path :: Lens' ListItems (Maybe Text) Source #
The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>
listItems_nextToken :: Lens' ListItems (Maybe Text) Source #
The token that identifies which batch of results that you want to see.
For example, you submit a ListItems
request with MaxResults
set at
500. The service returns the first batch of results (up to 500) and a
NextToken
value. To see the next batch of results, you can submit the
ListItems
request a second time and specify the NextToken
value.
Tokens expire after 15 minutes.
listItems_maxResults :: Lens' ListItems (Maybe Natural) Source #
The maximum number of results to return per API request. For example,
you submit a ListItems
request with MaxResults
set at 500. Although
2,000 items match your request, the service returns no more than the
first 500 items. (The service also returns a NextToken
value that you
can use to fetch the next batch of results.) The service might return
fewer results than the MaxResults
value.
If MaxResults
is not included in the request, the service defaults to
pagination with a maximum of 1,000 results per page.
listItemsResponse_items :: Lens' ListItemsResponse (Maybe [Item]) Source #
The metadata entries for the folders and objects at the requested path.
listItemsResponse_nextToken :: Lens' ListItemsResponse (Maybe Text) Source #
The token that can be used in a request to view the next set of results.
For example, you submit a ListItems
request that matches 2,000 items
with MaxResults
set at 500. The service returns the first batch of
results (up to 500) and a NextToken
value that can be used to fetch
the next batch of results.
listItemsResponse_httpStatus :: Lens' ListItemsResponse Int Source #
The response's http status code.
Types
Item
item_eTag :: Lens' Item (Maybe Text) Source #
The ETag that represents a unique instance of the item.