Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AbortMultipartUpload

abortMultipartUpload_expectedBucketOwner :: Lens' AbortMultipartUpload (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

abortMultipartUpload_requestPayer :: Lens' AbortMultipartUpload (Maybe RequestPayer) Source #

Undocumented member.

abortMultipartUpload_bucket :: Lens' AbortMultipartUpload BucketName Source #

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

abortMultipartUpload_key :: Lens' AbortMultipartUpload ObjectKey Source #

Key of the object for which the multipart upload was initiated.

abortMultipartUpload_uploadId :: Lens' AbortMultipartUpload Text Source #

Upload ID that identifies the multipart upload.

abortMultipartUploadResponse_requestCharged :: Lens' AbortMultipartUploadResponse (Maybe RequestCharged) Source #

Undocumented member.

abortMultipartUploadResponse_httpStatus :: Lens' AbortMultipartUploadResponse Int Source #

The response's http status code.

CompleteMultipartUpload

completeMultipartUpload_checksumCRC32 :: Lens' CompleteMultipartUpload (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUpload_checksumCRC32C :: Lens' CompleteMultipartUpload (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUpload_checksumSHA1 :: Lens' CompleteMultipartUpload (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUpload_checksumSHA256 :: Lens' CompleteMultipartUpload (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUpload_expectedBucketOwner :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

completeMultipartUpload_multipartUpload :: Lens' CompleteMultipartUpload (Maybe CompletedMultipartUpload) Source #

The container for the multipart upload request information.

completeMultipartUpload_requestPayer :: Lens' CompleteMultipartUpload (Maybe RequestPayer) Source #

Undocumented member.

completeMultipartUpload_sSECustomerAlgorithm :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

completeMultipartUpload_sSECustomerKey :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

completeMultipartUpload_sSECustomerKeyMD5 :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

completeMultipartUpload_bucket :: Lens' CompleteMultipartUpload BucketName Source #

Name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

completeMultipartUpload_key :: Lens' CompleteMultipartUpload ObjectKey Source #

Object key for which the multipart upload was initiated.

completeMultipartUpload_uploadId :: Lens' CompleteMultipartUpload Text Source #

ID for the initiated multipart upload.

completeMultipartUploadResponse_bucket :: Lens' CompleteMultipartUploadResponse (Maybe BucketName) Source #

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

completeMultipartUploadResponse_bucketKeyEnabled :: Lens' CompleteMultipartUploadResponse (Maybe Bool) Source #

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

completeMultipartUploadResponse_checksumCRC32 :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUploadResponse_checksumCRC32C :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUploadResponse_checksumSHA1 :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUploadResponse_checksumSHA256 :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUploadResponse_eTag :: Lens' CompleteMultipartUploadResponse (Maybe ETag) Source #

Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

completeMultipartUploadResponse_expiration :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

completeMultipartUploadResponse_key :: Lens' CompleteMultipartUploadResponse (Maybe ObjectKey) Source #

The object key of the newly created object.

completeMultipartUploadResponse_location :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

The URI that identifies the newly created object.

completeMultipartUploadResponse_requestCharged :: Lens' CompleteMultipartUploadResponse (Maybe RequestCharged) Source #

Undocumented member.

completeMultipartUploadResponse_sSEKMSKeyId :: Lens' CompleteMultipartUploadResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

completeMultipartUploadResponse_serverSideEncryption :: Lens' CompleteMultipartUploadResponse (Maybe ServerSideEncryption) Source #

If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS key in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

completeMultipartUploadResponse_versionId :: Lens' CompleteMultipartUploadResponse (Maybe ObjectVersionId) Source #

Version ID of the newly created object, in case the bucket has versioning turned on.

completeMultipartUploadResponse_httpStatus :: Lens' CompleteMultipartUploadResponse Int Source #

The response's http status code.

CopyObject

copyObject_acl :: Lens' CopyObject (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

copyObject_bucketKeyEnabled :: Lens' CopyObject (Maybe Bool) Source #

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

copyObject_cacheControl :: Lens' CopyObject (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

copyObject_checksumAlgorithm :: Lens' CopyObject (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

copyObject_contentDisposition :: Lens' CopyObject (Maybe Text) Source #

Specifies presentational information for the object.

copyObject_contentEncoding :: Lens' CopyObject (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

copyObject_contentLanguage :: Lens' CopyObject (Maybe Text) Source #

The language the content is in.

copyObject_contentType :: Lens' CopyObject (Maybe Text) Source #

A standard MIME type describing the format of the object data.

copyObject_copySourceIfMatch :: Lens' CopyObject (Maybe Text) Source #

Copies the object if its entity tag (ETag) matches the specified tag.

copyObject_copySourceIfModifiedSince :: Lens' CopyObject (Maybe UTCTime) Source #

Copies the object if it has been modified since the specified time.

copyObject_copySourceIfNoneMatch :: Lens' CopyObject (Maybe Text) Source #

Copies the object if its entity tag (ETag) is different than the specified ETag.

copyObject_copySourceIfUnmodifiedSince :: Lens' CopyObject (Maybe UTCTime) Source #

Copies the object if it hasn't been modified since the specified time.

copyObject_copySourceSSECustomerAlgorithm :: Lens' CopyObject (Maybe Text) Source #

Specifies the algorithm to use when decrypting the source object (for example, AES256).

copyObject_copySourceSSECustomerKey :: Lens' CopyObject (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

copyObject_copySourceSSECustomerKeyMD5 :: Lens' CopyObject (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

copyObject_expectedBucketOwner :: Lens' CopyObject (Maybe Text) Source #

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

copyObject_expectedSourceBucketOwner :: Lens' CopyObject (Maybe Text) Source #

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

copyObject_expires :: Lens' CopyObject (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable.

copyObject_grantFullControl :: Lens' CopyObject (Maybe Text) Source #

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

copyObject_grantRead :: Lens' CopyObject (Maybe Text) Source #

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

copyObject_grantReadACP :: Lens' CopyObject (Maybe Text) Source #

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

copyObject_grantWriteACP :: Lens' CopyObject (Maybe Text) Source #

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

copyObject_metadata :: Lens' CopyObject (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

copyObject_metadataDirective :: Lens' CopyObject (Maybe MetadataDirective) Source #

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

copyObject_objectLockLegalHoldStatus :: Lens' CopyObject (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether you want to apply a legal hold to the copied object.

copyObject_objectLockMode :: Lens' CopyObject (Maybe ObjectLockMode) Source #

The Object Lock mode that you want to apply to the copied object.

copyObject_objectLockRetainUntilDate :: Lens' CopyObject (Maybe UTCTime) Source #

The date and time when you want the copied object's Object Lock to expire.

copyObject_requestPayer :: Lens' CopyObject (Maybe RequestPayer) Source #

Undocumented member.

copyObject_sSECustomerAlgorithm :: Lens' CopyObject (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

copyObject_sSECustomerKey :: Lens' CopyObject (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

copyObject_sSECustomerKeyMD5 :: Lens' CopyObject (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

copyObject_sSEKMSEncryptionContext :: Lens' CopyObject (Maybe Text) Source #

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

copyObject_sSEKMSKeyId :: Lens' CopyObject (Maybe Text) Source #

Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

copyObject_serverSideEncryption :: Lens' CopyObject (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

copyObject_storageClass :: Lens' CopyObject (Maybe StorageClass) Source #

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

copyObject_tagging :: Lens' CopyObject (Maybe Text) Source #

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

copyObject_taggingDirective :: Lens' CopyObject (Maybe TaggingDirective) Source #

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

copyObject_websiteRedirectLocation :: Lens' CopyObject (Maybe Text) Source #

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

copyObject_bucket :: Lens' CopyObject BucketName Source #

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

copyObject_copySource :: Lens' CopyObject Text Source #

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

copyObject_key :: Lens' CopyObject ObjectKey Source #

The key of the destination object.

copyObjectResponse_bucketKeyEnabled :: Lens' CopyObjectResponse (Maybe Bool) Source #

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

copyObjectResponse_copyObjectResult :: Lens' CopyObjectResponse (Maybe CopyObjectResult) Source #

Container for all response elements.

copyObjectResponse_copySourceVersionId :: Lens' CopyObjectResponse (Maybe Text) Source #

Version of the copied object in the destination bucket.

copyObjectResponse_expiration :: Lens' CopyObjectResponse (Maybe Text) Source #

If the object expiration is configured, the response includes this header.

copyObjectResponse_requestCharged :: Lens' CopyObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

copyObjectResponse_sSECustomerAlgorithm :: Lens' CopyObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

copyObjectResponse_sSECustomerKeyMD5 :: Lens' CopyObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

copyObjectResponse_sSEKMSEncryptionContext :: Lens' CopyObjectResponse (Maybe Text) Source #

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

copyObjectResponse_sSEKMSKeyId :: Lens' CopyObjectResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

copyObjectResponse_serverSideEncryption :: Lens' CopyObjectResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

copyObjectResponse_versionId :: Lens' CopyObjectResponse (Maybe ObjectVersionId) Source #

Version ID of the newly created copy.

copyObjectResponse_httpStatus :: Lens' CopyObjectResponse Int Source #

The response's http status code.

CreateBucket

createBucket_acl :: Lens' CreateBucket (Maybe BucketCannedACL) Source #

The canned ACL to apply to the bucket.

createBucket_createBucketConfiguration :: Lens' CreateBucket (Maybe CreateBucketConfiguration) Source #

The configuration information for the bucket.

createBucket_grantFullControl :: Lens' CreateBucket (Maybe Text) Source #

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

createBucket_grantRead :: Lens' CreateBucket (Maybe Text) Source #

Allows grantee to list the objects in the bucket.

createBucket_grantReadACP :: Lens' CreateBucket (Maybe Text) Source #

Allows grantee to read the bucket ACL.

createBucket_grantWrite :: Lens' CreateBucket (Maybe Text) Source #

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

createBucket_grantWriteACP :: Lens' CreateBucket (Maybe Text) Source #

Allows grantee to write the ACL for the applicable bucket.

createBucket_objectLockEnabledForBucket :: Lens' CreateBucket (Maybe Bool) Source #

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

createBucket_objectOwnership :: Lens' CreateBucket (Maybe ObjectOwnership) Source #

Undocumented member.

createBucket_bucket :: Lens' CreateBucket BucketName Source #

The name of the bucket to create.

createBucketResponse_location :: Lens' CreateBucketResponse (Maybe Text) Source #

A forward slash followed by the name of the bucket.

createBucketResponse_httpStatus :: Lens' CreateBucketResponse Int Source #

The response's http status code.

CreateMultipartUpload

createMultipartUpload_acl :: Lens' CreateMultipartUpload (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_bucketKeyEnabled :: Lens' CreateMultipartUpload (Maybe Bool) Source #

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

createMultipartUpload_cacheControl :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

createMultipartUpload_checksumAlgorithm :: Lens' CreateMultipartUpload (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

createMultipartUpload_contentDisposition :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies presentational information for the object.

createMultipartUpload_contentEncoding :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

createMultipartUpload_contentLanguage :: Lens' CreateMultipartUpload (Maybe Text) Source #

The language the content is in.

createMultipartUpload_contentType :: Lens' CreateMultipartUpload (Maybe Text) Source #

A standard MIME type describing the format of the object data.

createMultipartUpload_expectedBucketOwner :: Lens' CreateMultipartUpload (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

createMultipartUpload_expires :: Lens' CreateMultipartUpload (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable.

createMultipartUpload_grantFullControl :: Lens' CreateMultipartUpload (Maybe Text) Source #

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_grantRead :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_grantReadACP :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_grantWriteACP :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_metadata :: Lens' CreateMultipartUpload (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

createMultipartUpload_objectLockLegalHoldStatus :: Lens' CreateMultipartUpload (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether you want to apply a legal hold to the uploaded object.

createMultipartUpload_objectLockMode :: Lens' CreateMultipartUpload (Maybe ObjectLockMode) Source #

Specifies the Object Lock mode that you want to apply to the uploaded object.

createMultipartUpload_objectLockRetainUntilDate :: Lens' CreateMultipartUpload (Maybe UTCTime) Source #

Specifies the date and time when you want the Object Lock to expire.

createMultipartUpload_requestPayer :: Lens' CreateMultipartUpload (Maybe RequestPayer) Source #

Undocumented member.

createMultipartUpload_sSECustomerAlgorithm :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

createMultipartUpload_sSECustomerKey :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

createMultipartUpload_sSECustomerKeyMD5 :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

createMultipartUpload_sSEKMSEncryptionContext :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

createMultipartUpload_sSEKMSKeyId :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

createMultipartUpload_serverSideEncryption :: Lens' CreateMultipartUpload (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

createMultipartUpload_storageClass :: Lens' CreateMultipartUpload (Maybe StorageClass) Source #

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

createMultipartUpload_tagging :: Lens' CreateMultipartUpload (Maybe Text) Source #

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

createMultipartUpload_websiteRedirectLocation :: Lens' CreateMultipartUpload (Maybe Text) Source #

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

createMultipartUpload_bucket :: Lens' CreateMultipartUpload BucketName Source #

The name of the bucket to which to initiate the upload

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

createMultipartUpload_key :: Lens' CreateMultipartUpload ObjectKey Source #

Object key for which the multipart upload is to be initiated.

createMultipartUploadResponse_abortDate :: Lens' CreateMultipartUploadResponse (Maybe UTCTime) Source #

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

createMultipartUploadResponse_abortRuleId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

createMultipartUploadResponse_bucket :: Lens' CreateMultipartUploadResponse (Maybe BucketName) Source #

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

createMultipartUploadResponse_bucketKeyEnabled :: Lens' CreateMultipartUploadResponse (Maybe Bool) Source #

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

createMultipartUploadResponse_checksumAlgorithm :: Lens' CreateMultipartUploadResponse (Maybe ChecksumAlgorithm) Source #

The algorithm that was used to create a checksum of the object.

createMultipartUploadResponse_key :: Lens' CreateMultipartUploadResponse (Maybe ObjectKey) Source #

Object key for which the multipart upload was initiated.

createMultipartUploadResponse_requestCharged :: Lens' CreateMultipartUploadResponse (Maybe RequestCharged) Source #

Undocumented member.

createMultipartUploadResponse_sSECustomerAlgorithm :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

createMultipartUploadResponse_sSECustomerKeyMD5 :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

createMultipartUploadResponse_sSEKMSEncryptionContext :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

createMultipartUploadResponse_sSEKMSKeyId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

createMultipartUploadResponse_serverSideEncryption :: Lens' CreateMultipartUploadResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

createMultipartUploadResponse_httpStatus :: Lens' CreateMultipartUploadResponse Int Source #

The response's http status code.

createMultipartUploadResponse_uploadId :: Lens' CreateMultipartUploadResponse Text Source #

ID for the initiated multipart upload.

DeleteBucket

deleteBucket_expectedBucketOwner :: Lens' DeleteBucket (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucket_bucket :: Lens' DeleteBucket BucketName Source #

Specifies the bucket being deleted.

DeleteBucketAnalyticsConfiguration

deleteBucketAnalyticsConfiguration_expectedBucketOwner :: Lens' DeleteBucketAnalyticsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketAnalyticsConfiguration_bucket :: Lens' DeleteBucketAnalyticsConfiguration BucketName Source #

The name of the bucket from which an analytics configuration is deleted.

deleteBucketAnalyticsConfiguration_id :: Lens' DeleteBucketAnalyticsConfiguration Text Source #

The ID that identifies the analytics configuration.

DeleteBucketCors

deleteBucketCors_expectedBucketOwner :: Lens' DeleteBucketCors (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketCors_bucket :: Lens' DeleteBucketCors BucketName Source #

Specifies the bucket whose cors configuration is being deleted.

DeleteBucketEncryption

deleteBucketEncryption_expectedBucketOwner :: Lens' DeleteBucketEncryption (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketEncryption_bucket :: Lens' DeleteBucketEncryption BucketName Source #

The name of the bucket containing the server-side encryption configuration to delete.

DeleteBucketIntelligentTieringConfiguration

deleteBucketIntelligentTieringConfiguration_bucket :: Lens' DeleteBucketIntelligentTieringConfiguration BucketName Source #

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

deleteBucketIntelligentTieringConfiguration_id :: Lens' DeleteBucketIntelligentTieringConfiguration Text Source #

The ID used to identify the S3 Intelligent-Tiering configuration.

DeleteBucketInventoryConfiguration

deleteBucketInventoryConfiguration_expectedBucketOwner :: Lens' DeleteBucketInventoryConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketInventoryConfiguration_bucket :: Lens' DeleteBucketInventoryConfiguration BucketName Source #

The name of the bucket containing the inventory configuration to delete.

deleteBucketInventoryConfiguration_id :: Lens' DeleteBucketInventoryConfiguration Text Source #

The ID used to identify the inventory configuration.

DeleteBucketLifecycle

deleteBucketLifecycle_expectedBucketOwner :: Lens' DeleteBucketLifecycle (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketLifecycle_bucket :: Lens' DeleteBucketLifecycle BucketName Source #

The bucket name of the lifecycle to delete.

DeleteBucketMetricsConfiguration

deleteBucketMetricsConfiguration_expectedBucketOwner :: Lens' DeleteBucketMetricsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketMetricsConfiguration_bucket :: Lens' DeleteBucketMetricsConfiguration BucketName Source #

The name of the bucket containing the metrics configuration to delete.

deleteBucketMetricsConfiguration_id :: Lens' DeleteBucketMetricsConfiguration Text Source #

The ID used to identify the metrics configuration.

DeleteBucketOwnershipControls

deleteBucketOwnershipControls_expectedBucketOwner :: Lens' DeleteBucketOwnershipControls (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketOwnershipControls_bucket :: Lens' DeleteBucketOwnershipControls BucketName Source #

The Amazon S3 bucket whose OwnershipControls you want to delete.

DeleteBucketPolicy

deleteBucketPolicy_expectedBucketOwner :: Lens' DeleteBucketPolicy (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketPolicy_bucket :: Lens' DeleteBucketPolicy BucketName Source #

The bucket name.

DeleteBucketReplication

deleteBucketReplication_expectedBucketOwner :: Lens' DeleteBucketReplication (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketReplication_bucket :: Lens' DeleteBucketReplication BucketName Source #

The bucket name.

DeleteBucketTagging

deleteBucketTagging_expectedBucketOwner :: Lens' DeleteBucketTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketTagging_bucket :: Lens' DeleteBucketTagging BucketName Source #

The bucket that has the tag set to be removed.

DeleteBucketWebsite

deleteBucketWebsite_expectedBucketOwner :: Lens' DeleteBucketWebsite (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteBucketWebsite_bucket :: Lens' DeleteBucketWebsite BucketName Source #

The bucket name for which you want to remove the website configuration.

DeleteObject

deleteObject_bypassGovernanceRetention :: Lens' DeleteObject (Maybe Bool) Source #

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

deleteObject_expectedBucketOwner :: Lens' DeleteObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteObject_mfa :: Lens' DeleteObject (Maybe Text) Source #

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

deleteObject_requestPayer :: Lens' DeleteObject (Maybe RequestPayer) Source #

Undocumented member.

deleteObject_versionId :: Lens' DeleteObject (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

deleteObject_bucket :: Lens' DeleteObject BucketName Source #

The bucket name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

deleteObject_key :: Lens' DeleteObject ObjectKey Source #

Key name of the object to delete.

deleteObjectResponse_deleteMarker :: Lens' DeleteObjectResponse (Maybe Bool) Source #

Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

deleteObjectResponse_requestCharged :: Lens' DeleteObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

deleteObjectResponse_versionId :: Lens' DeleteObjectResponse (Maybe ObjectVersionId) Source #

Returns the version ID of the delete marker created as a result of the DELETE operation.

deleteObjectResponse_httpStatus :: Lens' DeleteObjectResponse Int Source #

The response's http status code.

DeleteObjectTagging

deleteObjectTagging_expectedBucketOwner :: Lens' DeleteObjectTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteObjectTagging_versionId :: Lens' DeleteObjectTagging (Maybe ObjectVersionId) Source #

The versionId of the object that the tag-set will be removed from.

deleteObjectTagging_bucket :: Lens' DeleteObjectTagging BucketName Source #

The bucket name containing the objects from which to remove the tags.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

deleteObjectTagging_key :: Lens' DeleteObjectTagging ObjectKey Source #

The key that identifies the object in the bucket from which to remove all tags.

deleteObjectTaggingResponse_versionId :: Lens' DeleteObjectTaggingResponse (Maybe ObjectVersionId) Source #

The versionId of the object the tag-set was removed from.

deleteObjectTaggingResponse_httpStatus :: Lens' DeleteObjectTaggingResponse Int Source #

The response's http status code.

DeleteObjects

deleteObjects_bypassGovernanceRetention :: Lens' DeleteObjects (Maybe Bool) Source #

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

deleteObjects_checksumAlgorithm :: Lens' DeleteObjects (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

deleteObjects_expectedBucketOwner :: Lens' DeleteObjects (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteObjects_mfa :: Lens' DeleteObjects (Maybe Text) Source #

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

deleteObjects_requestPayer :: Lens' DeleteObjects (Maybe RequestPayer) Source #

Undocumented member.

deleteObjects_bucket :: Lens' DeleteObjects BucketName Source #

The bucket name containing the objects to delete.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

deleteObjects_delete :: Lens' DeleteObjects Delete Source #

Container for the request.

deleteObjectsResponse_deleted :: Lens' DeleteObjectsResponse (Maybe [DeletedObject]) Source #

Container element for a successful delete. It identifies the object that was successfully deleted.

deleteObjectsResponse_errors :: Lens' DeleteObjectsResponse (Maybe [S3ServiceError]) Source #

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

deleteObjectsResponse_requestCharged :: Lens' DeleteObjectsResponse (Maybe RequestCharged) Source #

Undocumented member.

deleteObjectsResponse_httpStatus :: Lens' DeleteObjectsResponse Int Source #

The response's http status code.

DeletePublicAccessBlock

deletePublicAccessBlock_expectedBucketOwner :: Lens' DeletePublicAccessBlock (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deletePublicAccessBlock_bucket :: Lens' DeletePublicAccessBlock BucketName Source #

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

GetBucketAccelerateConfiguration

getBucketAccelerateConfiguration_expectedBucketOwner :: Lens' GetBucketAccelerateConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketAccelerateConfiguration_bucket :: Lens' GetBucketAccelerateConfiguration BucketName Source #

The name of the bucket for which the accelerate configuration is retrieved.

getBucketAccelerateConfigurationResponse_status :: Lens' GetBucketAccelerateConfigurationResponse (Maybe BucketAccelerateStatus) Source #

The accelerate configuration of the bucket.

getBucketAccelerateConfigurationResponse_httpStatus :: Lens' GetBucketAccelerateConfigurationResponse Int Source #

The response's http status code.

GetBucketAcl

getBucketAcl_expectedBucketOwner :: Lens' GetBucketAcl (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketAcl_bucket :: Lens' GetBucketAcl BucketName Source #

Specifies the S3 bucket whose ACL is being requested.

getBucketAclResponse_grants :: Lens' GetBucketAclResponse (Maybe [Grant]) Source #

A list of grants.

getBucketAclResponse_owner :: Lens' GetBucketAclResponse (Maybe Owner) Source #

Container for the bucket owner's display name and ID.

getBucketAclResponse_httpStatus :: Lens' GetBucketAclResponse Int Source #

The response's http status code.

GetBucketAnalyticsConfiguration

getBucketAnalyticsConfiguration_expectedBucketOwner :: Lens' GetBucketAnalyticsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketAnalyticsConfiguration_bucket :: Lens' GetBucketAnalyticsConfiguration BucketName Source #

The name of the bucket from which an analytics configuration is retrieved.

getBucketAnalyticsConfiguration_id :: Lens' GetBucketAnalyticsConfiguration Text Source #

The ID that identifies the analytics configuration.

getBucketAnalyticsConfigurationResponse_analyticsConfiguration :: Lens' GetBucketAnalyticsConfigurationResponse (Maybe AnalyticsConfiguration) Source #

The configuration and any analyses for the analytics filter.

getBucketAnalyticsConfigurationResponse_httpStatus :: Lens' GetBucketAnalyticsConfigurationResponse Int Source #

The response's http status code.

GetBucketCors

getBucketCors_expectedBucketOwner :: Lens' GetBucketCors (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketCors_bucket :: Lens' GetBucketCors BucketName Source #

The bucket name for which to get the cors configuration.

getBucketCorsResponse_cORSRules :: Lens' GetBucketCorsResponse (Maybe [CORSRule]) Source #

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

getBucketCorsResponse_httpStatus :: Lens' GetBucketCorsResponse Int Source #

The response's http status code.

GetBucketEncryption

getBucketEncryption_expectedBucketOwner :: Lens' GetBucketEncryption (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketEncryption_bucket :: Lens' GetBucketEncryption BucketName Source #

The name of the bucket from which the server-side encryption configuration is retrieved.

getBucketEncryptionResponse_serverSideEncryptionConfiguration :: Lens' GetBucketEncryptionResponse (Maybe ServerSideEncryptionConfiguration) Source #

Undocumented member.

getBucketEncryptionResponse_httpStatus :: Lens' GetBucketEncryptionResponse Int Source #

The response's http status code.

GetBucketIntelligentTieringConfiguration

getBucketIntelligentTieringConfiguration_bucket :: Lens' GetBucketIntelligentTieringConfiguration BucketName Source #

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

getBucketIntelligentTieringConfiguration_id :: Lens' GetBucketIntelligentTieringConfiguration Text Source #

The ID used to identify the S3 Intelligent-Tiering configuration.

getBucketIntelligentTieringConfigurationResponse_intelligentTieringConfiguration :: Lens' GetBucketIntelligentTieringConfigurationResponse (Maybe IntelligentTieringConfiguration) Source #

Container for S3 Intelligent-Tiering configuration.

getBucketIntelligentTieringConfigurationResponse_httpStatus :: Lens' GetBucketIntelligentTieringConfigurationResponse Int Source #

The response's http status code.

GetBucketInventoryConfiguration

getBucketInventoryConfiguration_expectedBucketOwner :: Lens' GetBucketInventoryConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketInventoryConfiguration_bucket :: Lens' GetBucketInventoryConfiguration BucketName Source #

The name of the bucket containing the inventory configuration to retrieve.

getBucketInventoryConfiguration_id :: Lens' GetBucketInventoryConfiguration Text Source #

The ID used to identify the inventory configuration.

getBucketInventoryConfigurationResponse_inventoryConfiguration :: Lens' GetBucketInventoryConfigurationResponse (Maybe InventoryConfiguration) Source #

Specifies the inventory configuration.

getBucketInventoryConfigurationResponse_httpStatus :: Lens' GetBucketInventoryConfigurationResponse Int Source #

The response's http status code.

GetBucketLifecycleConfiguration

getBucketLifecycleConfiguration_expectedBucketOwner :: Lens' GetBucketLifecycleConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketLifecycleConfiguration_bucket :: Lens' GetBucketLifecycleConfiguration BucketName Source #

The name of the bucket for which to get the lifecycle information.

getBucketLifecycleConfigurationResponse_rules :: Lens' GetBucketLifecycleConfigurationResponse (Maybe [LifecycleRule]) Source #

Container for a lifecycle rule.

getBucketLifecycleConfigurationResponse_httpStatus :: Lens' GetBucketLifecycleConfigurationResponse Int Source #

The response's http status code.

GetBucketLocation

getBucketLocation_expectedBucketOwner :: Lens' GetBucketLocation (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketLocation_bucket :: Lens' GetBucketLocation BucketName Source #

The name of the bucket for which to get the location.

getBucketLocationResponse_httpStatus :: Lens' GetBucketLocationResponse Int Source #

The response's http status code.

getBucketLocationResponse_locationConstraint :: Lens' GetBucketLocationResponse LocationConstraint Source #

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

GetBucketLogging

getBucketLogging_expectedBucketOwner :: Lens' GetBucketLogging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketLogging_bucket :: Lens' GetBucketLogging BucketName Source #

The bucket name for which to get the logging information.

getBucketLoggingResponse_loggingEnabled :: Lens' GetBucketLoggingResponse (Maybe LoggingEnabled) Source #

Undocumented member.

getBucketLoggingResponse_httpStatus :: Lens' GetBucketLoggingResponse Int Source #

The response's http status code.

GetBucketMetricsConfiguration

getBucketMetricsConfiguration_expectedBucketOwner :: Lens' GetBucketMetricsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketMetricsConfiguration_bucket :: Lens' GetBucketMetricsConfiguration BucketName Source #

The name of the bucket containing the metrics configuration to retrieve.

getBucketMetricsConfiguration_id :: Lens' GetBucketMetricsConfiguration Text Source #

The ID used to identify the metrics configuration.

getBucketMetricsConfigurationResponse_metricsConfiguration :: Lens' GetBucketMetricsConfigurationResponse (Maybe MetricsConfiguration) Source #

Specifies the metrics configuration.

getBucketMetricsConfigurationResponse_httpStatus :: Lens' GetBucketMetricsConfigurationResponse Int Source #

The response's http status code.

GetBucketNotificationConfiguration

getBucketNotificationConfiguration_expectedBucketOwner :: Lens' GetBucketNotificationConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketNotificationConfiguration_bucket :: Lens' GetBucketNotificationConfiguration BucketName Source #

The name of the bucket for which to get the notification configuration.

notificationConfiguration_eventBridgeConfiguration :: Lens' NotificationConfiguration (Maybe EventBridgeConfiguration) Source #

Enables delivery of events to Amazon EventBridge.

notificationConfiguration_lambdaFunctionConfigurations :: Lens' NotificationConfiguration (Maybe [LambdaFunctionConfiguration]) Source #

Describes the Lambda functions to invoke and the events for which to invoke them.

notificationConfiguration_queueConfigurations :: Lens' NotificationConfiguration (Maybe [QueueConfiguration]) Source #

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

notificationConfiguration_topicConfigurations :: Lens' NotificationConfiguration (Maybe [TopicConfiguration]) Source #

The topic to which notifications are sent and the events for which notifications are generated.

GetBucketOwnershipControls

getBucketOwnershipControls_expectedBucketOwner :: Lens' GetBucketOwnershipControls (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketOwnershipControls_bucket :: Lens' GetBucketOwnershipControls BucketName Source #

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

getBucketOwnershipControlsResponse_ownershipControls :: Lens' GetBucketOwnershipControlsResponse (Maybe OwnershipControls) Source #

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

getBucketOwnershipControlsResponse_httpStatus :: Lens' GetBucketOwnershipControlsResponse Int Source #

The response's http status code.

GetBucketPolicy

getBucketPolicy_expectedBucketOwner :: Lens' GetBucketPolicy (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketPolicy_bucket :: Lens' GetBucketPolicy BucketName Source #

The bucket name for which to get the bucket policy.

getBucketPolicyResponse_httpStatus :: Lens' GetBucketPolicyResponse Int Source #

The response's http status code.

getBucketPolicyResponse_policy :: Lens' GetBucketPolicyResponse ByteString Source #

The bucket policy as a JSON document.

GetBucketPolicyStatus

getBucketPolicyStatus_expectedBucketOwner :: Lens' GetBucketPolicyStatus (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketPolicyStatus_bucket :: Lens' GetBucketPolicyStatus BucketName Source #

The name of the Amazon S3 bucket whose policy status you want to retrieve.

getBucketPolicyStatusResponse_policyStatus :: Lens' GetBucketPolicyStatusResponse (Maybe PolicyStatus) Source #

The policy status for the specified bucket.

getBucketPolicyStatusResponse_httpStatus :: Lens' GetBucketPolicyStatusResponse Int Source #

The response's http status code.

GetBucketReplication

getBucketReplication_expectedBucketOwner :: Lens' GetBucketReplication (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketReplication_bucket :: Lens' GetBucketReplication BucketName Source #

The bucket name for which to get the replication information.

getBucketReplicationResponse_replicationConfiguration :: Lens' GetBucketReplicationResponse (Maybe ReplicationConfiguration) Source #

Undocumented member.

getBucketReplicationResponse_httpStatus :: Lens' GetBucketReplicationResponse Int Source #

The response's http status code.

GetBucketRequestPayment

getBucketRequestPayment_expectedBucketOwner :: Lens' GetBucketRequestPayment (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketRequestPayment_bucket :: Lens' GetBucketRequestPayment BucketName Source #

The name of the bucket for which to get the payment request configuration

getBucketRequestPaymentResponse_payer :: Lens' GetBucketRequestPaymentResponse (Maybe Payer) Source #

Specifies who pays for the download and request fees.

getBucketRequestPaymentResponse_httpStatus :: Lens' GetBucketRequestPaymentResponse Int Source #

The response's http status code.

GetBucketTagging

getBucketTagging_expectedBucketOwner :: Lens' GetBucketTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketTagging_bucket :: Lens' GetBucketTagging BucketName Source #

The name of the bucket for which to get the tagging information.

getBucketTaggingResponse_httpStatus :: Lens' GetBucketTaggingResponse Int Source #

The response's http status code.

getBucketTaggingResponse_tagSet :: Lens' GetBucketTaggingResponse [Tag] Source #

Contains the tag set.

GetBucketVersioning

getBucketVersioning_expectedBucketOwner :: Lens' GetBucketVersioning (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketVersioning_bucket :: Lens' GetBucketVersioning BucketName Source #

The name of the bucket for which to get the versioning information.

getBucketVersioningResponse_mfaDelete :: Lens' GetBucketVersioningResponse (Maybe MFADeleteStatus) Source #

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

getBucketVersioningResponse_status :: Lens' GetBucketVersioningResponse (Maybe BucketVersioningStatus) Source #

The versioning state of the bucket.

getBucketVersioningResponse_httpStatus :: Lens' GetBucketVersioningResponse Int Source #

The response's http status code.

GetBucketWebsite

getBucketWebsite_expectedBucketOwner :: Lens' GetBucketWebsite (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getBucketWebsite_bucket :: Lens' GetBucketWebsite BucketName Source #

The bucket name for which to get the website configuration.

getBucketWebsiteResponse_errorDocument :: Lens' GetBucketWebsiteResponse (Maybe ErrorDocument) Source #

The object key name of the website error document to use for 4XX class errors.

getBucketWebsiteResponse_indexDocument :: Lens' GetBucketWebsiteResponse (Maybe IndexDocument) Source #

The name of the index document for the website (for example index.html).

getBucketWebsiteResponse_redirectAllRequestsTo :: Lens' GetBucketWebsiteResponse (Maybe RedirectAllRequestsTo) Source #

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

getBucketWebsiteResponse_routingRules :: Lens' GetBucketWebsiteResponse (Maybe [RoutingRule]) Source #

Rules that define when a redirect is applied and the redirect behavior.

getBucketWebsiteResponse_httpStatus :: Lens' GetBucketWebsiteResponse Int Source #

The response's http status code.

GetObject

getObject_checksumMode :: Lens' GetObject (Maybe ChecksumMode) Source #

To retrieve the checksum, this mode must be enabled.

getObject_expectedBucketOwner :: Lens' GetObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObject_ifMatch :: Lens' GetObject (Maybe Text) Source #

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

getObject_ifModifiedSince :: Lens' GetObject (Maybe UTCTime) Source #

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

getObject_ifNoneMatch :: Lens' GetObject (Maybe Text) Source #

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

getObject_ifUnmodifiedSince :: Lens' GetObject (Maybe UTCTime) Source #

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

getObject_partNumber :: Lens' GetObject (Maybe Int) Source #

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

getObject_range :: Lens' GetObject (Maybe Text) Source #

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

getObject_requestPayer :: Lens' GetObject (Maybe RequestPayer) Source #

Undocumented member.

getObject_responseCacheControl :: Lens' GetObject (Maybe Text) Source #

Sets the Cache-Control header of the response.

getObject_responseContentDisposition :: Lens' GetObject (Maybe Text) Source #

Sets the Content-Disposition header of the response

getObject_responseContentEncoding :: Lens' GetObject (Maybe Text) Source #

Sets the Content-Encoding header of the response.

getObject_responseContentLanguage :: Lens' GetObject (Maybe Text) Source #

Sets the Content-Language header of the response.

getObject_responseContentType :: Lens' GetObject (Maybe Text) Source #

Sets the Content-Type header of the response.

getObject_responseExpires :: Lens' GetObject (Maybe UTCTime) Source #

Sets the Expires header of the response.

getObject_sSECustomerAlgorithm :: Lens' GetObject (Maybe Text) Source #

Specifies the algorithm to use to when decrypting the object (for example, AES256).

getObject_sSECustomerKey :: Lens' GetObject (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

getObject_sSECustomerKeyMD5 :: Lens' GetObject (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

getObject_versionId :: Lens' GetObject (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

getObject_bucket :: Lens' GetObject BucketName Source #

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

getObject_key :: Lens' GetObject ObjectKey Source #

Key of the object to get.

getObjectResponse_acceptRanges :: Lens' GetObjectResponse (Maybe Text) Source #

Indicates that a range of bytes was specified.

getObjectResponse_bucketKeyEnabled :: Lens' GetObjectResponse (Maybe Bool) Source #

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

getObjectResponse_cacheControl :: Lens' GetObjectResponse (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

getObjectResponse_checksumCRC32 :: Lens' GetObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

getObjectResponse_checksumCRC32C :: Lens' GetObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

getObjectResponse_checksumSHA1 :: Lens' GetObjectResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

getObjectResponse_checksumSHA256 :: Lens' GetObjectResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

getObjectResponse_contentDisposition :: Lens' GetObjectResponse (Maybe Text) Source #

Specifies presentational information for the object.

getObjectResponse_contentEncoding :: Lens' GetObjectResponse (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

getObjectResponse_contentLanguage :: Lens' GetObjectResponse (Maybe Text) Source #

The language the content is in.

getObjectResponse_contentLength :: Lens' GetObjectResponse (Maybe Integer) Source #

Size of the body in bytes.

getObjectResponse_contentRange :: Lens' GetObjectResponse (Maybe Text) Source #

The portion of the object returned in the response.

getObjectResponse_contentType :: Lens' GetObjectResponse (Maybe Text) Source #

A standard MIME type describing the format of the object data.

getObjectResponse_deleteMarker :: Lens' GetObjectResponse (Maybe Bool) Source #

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

getObjectResponse_eTag :: Lens' GetObjectResponse (Maybe ETag) Source #

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

getObjectResponse_expiration :: Lens' GetObjectResponse (Maybe Text) Source #

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

getObjectResponse_expires :: Lens' GetObjectResponse (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable.

getObjectResponse_lastModified :: Lens' GetObjectResponse (Maybe UTCTime) Source #

Creation date of the object.

getObjectResponse_metadata :: Lens' GetObjectResponse (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

getObjectResponse_missingMeta :: Lens' GetObjectResponse (Maybe Int) Source #

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

getObjectResponse_objectLockLegalHoldStatus :: Lens' GetObjectResponse (Maybe ObjectLockLegalHoldStatus) Source #

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

getObjectResponse_objectLockMode :: Lens' GetObjectResponse (Maybe ObjectLockMode) Source #

The Object Lock mode currently in place for this object.

getObjectResponse_objectLockRetainUntilDate :: Lens' GetObjectResponse (Maybe UTCTime) Source #

The date and time when this object's Object Lock will expire.

getObjectResponse_partsCount :: Lens' GetObjectResponse (Maybe Int) Source #

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

getObjectResponse_replicationStatus :: Lens' GetObjectResponse (Maybe ReplicationStatus) Source #

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

getObjectResponse_requestCharged :: Lens' GetObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectResponse_restore :: Lens' GetObjectResponse (Maybe Text) Source #

Provides information about object restoration action and expiration time of the restored object copy.

getObjectResponse_sSECustomerAlgorithm :: Lens' GetObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

getObjectResponse_sSECustomerKeyMD5 :: Lens' GetObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

getObjectResponse_sSEKMSKeyId :: Lens' GetObjectResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

getObjectResponse_serverSideEncryption :: Lens' GetObjectResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

getObjectResponse_storageClass :: Lens' GetObjectResponse (Maybe StorageClass) Source #

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

getObjectResponse_tagCount :: Lens' GetObjectResponse (Maybe Int) Source #

The number of tags, if any, on the object.

getObjectResponse_versionId :: Lens' GetObjectResponse (Maybe ObjectVersionId) Source #

Version of the object.

getObjectResponse_websiteRedirectLocation :: Lens' GetObjectResponse (Maybe Text) Source #

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

getObjectResponse_httpStatus :: Lens' GetObjectResponse Int Source #

The response's http status code.

getObjectResponse_body :: Lens' GetObjectResponse ResponseBody Source #

Object data.

GetObjectAcl

getObjectAcl_expectedBucketOwner :: Lens' GetObjectAcl (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectAcl_requestPayer :: Lens' GetObjectAcl (Maybe RequestPayer) Source #

Undocumented member.

getObjectAcl_versionId :: Lens' GetObjectAcl (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

getObjectAcl_bucket :: Lens' GetObjectAcl BucketName Source #

The bucket name that contains the object for which to get the ACL information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

getObjectAcl_key :: Lens' GetObjectAcl ObjectKey Source #

The key of the object for which to get the ACL information.

getObjectAclResponse_grants :: Lens' GetObjectAclResponse (Maybe [Grant]) Source #

A list of grants.

getObjectAclResponse_owner :: Lens' GetObjectAclResponse (Maybe Owner) Source #

Container for the bucket owner's display name and ID.

getObjectAclResponse_requestCharged :: Lens' GetObjectAclResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectAclResponse_httpStatus :: Lens' GetObjectAclResponse Int Source #

The response's http status code.

GetObjectAttributes

getObjectAttributes_expectedBucketOwner :: Lens' GetObjectAttributes (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectAttributes_maxParts :: Lens' GetObjectAttributes (Maybe Int) Source #

Sets the maximum number of parts to return.

getObjectAttributes_partNumberMarker :: Lens' GetObjectAttributes (Maybe Int) Source #

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

getObjectAttributes_requestPayer :: Lens' GetObjectAttributes (Maybe RequestPayer) Source #

Undocumented member.

getObjectAttributes_sSECustomerAlgorithm :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the algorithm to use when encrypting the object (for example, AES256).

getObjectAttributes_sSECustomerKey :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

getObjectAttributes_sSECustomerKeyMD5 :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

getObjectAttributes_versionId :: Lens' GetObjectAttributes (Maybe ObjectVersionId) Source #

The version ID used to reference a specific version of the object.

getObjectAttributes_bucket :: Lens' GetObjectAttributes BucketName Source #

The name of the bucket that contains the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

getObjectAttributes_key :: Lens' GetObjectAttributes ObjectKey Source #

The object key.

getObjectAttributes_objectAttributes :: Lens' GetObjectAttributes [ObjectAttributes] Source #

An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

getObjectAttributesResponse_checksum :: Lens' GetObjectAttributesResponse (Maybe Checksum) Source #

The checksum or digest of the object.

getObjectAttributesResponse_deleteMarker :: Lens' GetObjectAttributesResponse (Maybe Bool) Source #

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

getObjectAttributesResponse_eTag :: Lens' GetObjectAttributesResponse (Maybe ETag) Source #

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

getObjectAttributesResponse_lastModified :: Lens' GetObjectAttributesResponse (Maybe UTCTime) Source #

The creation date of the object.

getObjectAttributesResponse_objectParts :: Lens' GetObjectAttributesResponse (Maybe GetObjectAttributesParts) Source #

A collection of parts associated with a multipart upload.

getObjectAttributesResponse_objectSize :: Lens' GetObjectAttributesResponse (Maybe Integer) Source #

The size of the object in bytes.

getObjectAttributesResponse_requestCharged :: Lens' GetObjectAttributesResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectAttributesResponse_storageClass :: Lens' GetObjectAttributesResponse (Maybe StorageClass) Source #

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

getObjectAttributesResponse_versionId :: Lens' GetObjectAttributesResponse (Maybe ObjectVersionId) Source #

The version ID of the object.

getObjectAttributesResponse_httpStatus :: Lens' GetObjectAttributesResponse Int Source #

The response's http status code.

GetObjectLegalHold

getObjectLegalHold_expectedBucketOwner :: Lens' GetObjectLegalHold (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectLegalHold_requestPayer :: Lens' GetObjectLegalHold (Maybe RequestPayer) Source #

Undocumented member.

getObjectLegalHold_versionId :: Lens' GetObjectLegalHold (Maybe ObjectVersionId) Source #

The version ID of the object whose legal hold status you want to retrieve.

getObjectLegalHold_bucket :: Lens' GetObjectLegalHold BucketName Source #

The bucket name containing the object whose legal hold status you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

getObjectLegalHold_key :: Lens' GetObjectLegalHold ObjectKey Source #

The key name for the object whose legal hold status you want to retrieve.

getObjectLegalHoldResponse_legalHold :: Lens' GetObjectLegalHoldResponse (Maybe ObjectLockLegalHold) Source #

The current legal hold status for the specified object.

getObjectLegalHoldResponse_httpStatus :: Lens' GetObjectLegalHoldResponse Int Source #

The response's http status code.

GetObjectLockConfiguration

getObjectLockConfiguration_expectedBucketOwner :: Lens' GetObjectLockConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectLockConfiguration_bucket :: Lens' GetObjectLockConfiguration BucketName Source #

The bucket whose Object Lock configuration you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

getObjectLockConfigurationResponse_objectLockConfiguration :: Lens' GetObjectLockConfigurationResponse (Maybe ObjectLockConfiguration) Source #

The specified bucket's Object Lock configuration.

getObjectLockConfigurationResponse_httpStatus :: Lens' GetObjectLockConfigurationResponse Int Source #

The response's http status code.

GetObjectRetention

getObjectRetention_expectedBucketOwner :: Lens' GetObjectRetention (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectRetention_requestPayer :: Lens' GetObjectRetention (Maybe RequestPayer) Source #

Undocumented member.

getObjectRetention_versionId :: Lens' GetObjectRetention (Maybe ObjectVersionId) Source #

The version ID for the object whose retention settings you want to retrieve.

getObjectRetention_bucket :: Lens' GetObjectRetention BucketName Source #

The bucket name containing the object whose retention settings you want to retrieve.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

getObjectRetention_key :: Lens' GetObjectRetention ObjectKey Source #

The key name for the object whose retention settings you want to retrieve.

getObjectRetentionResponse_retention :: Lens' GetObjectRetentionResponse (Maybe ObjectLockRetention) Source #

The container element for an object's retention settings.

getObjectRetentionResponse_httpStatus :: Lens' GetObjectRetentionResponse Int Source #

The response's http status code.

GetObjectTagging

getObjectTagging_expectedBucketOwner :: Lens' GetObjectTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectTagging_requestPayer :: Lens' GetObjectTagging (Maybe RequestPayer) Source #

Undocumented member.

getObjectTagging_versionId :: Lens' GetObjectTagging (Maybe ObjectVersionId) Source #

The versionId of the object for which to get the tagging information.

getObjectTagging_bucket :: Lens' GetObjectTagging BucketName Source #

The bucket name containing the object for which to get the tagging information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

getObjectTagging_key :: Lens' GetObjectTagging ObjectKey Source #

Object key for which to get the tagging information.

getObjectTaggingResponse_versionId :: Lens' GetObjectTaggingResponse (Maybe ObjectVersionId) Source #

The versionId of the object for which you got the tagging information.

getObjectTaggingResponse_httpStatus :: Lens' GetObjectTaggingResponse Int Source #

The response's http status code.

getObjectTaggingResponse_tagSet :: Lens' GetObjectTaggingResponse [Tag] Source #

Contains the tag set.

GetObjectTorrent

getObjectTorrent_expectedBucketOwner :: Lens' GetObjectTorrent (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getObjectTorrent_requestPayer :: Lens' GetObjectTorrent (Maybe RequestPayer) Source #

Undocumented member.

getObjectTorrent_bucket :: Lens' GetObjectTorrent BucketName Source #

The name of the bucket containing the object for which to get the torrent files.

getObjectTorrent_key :: Lens' GetObjectTorrent ObjectKey Source #

The object key for which to get the information.

getObjectTorrentResponse_requestCharged :: Lens' GetObjectTorrentResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectTorrentResponse_httpStatus :: Lens' GetObjectTorrentResponse Int Source #

The response's http status code.

getObjectTorrentResponse_body :: Lens' GetObjectTorrentResponse ResponseBody Source #

A Bencoded dictionary as defined by the BitTorrent specification

GetPublicAccessBlock

getPublicAccessBlock_expectedBucketOwner :: Lens' GetPublicAccessBlock (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

getPublicAccessBlock_bucket :: Lens' GetPublicAccessBlock BucketName Source #

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

getPublicAccessBlockResponse_publicAccessBlockConfiguration :: Lens' GetPublicAccessBlockResponse (Maybe PublicAccessBlockConfiguration) Source #

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

getPublicAccessBlockResponse_httpStatus :: Lens' GetPublicAccessBlockResponse Int Source #

The response's http status code.

HeadBucket

headBucket_expectedBucketOwner :: Lens' HeadBucket (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

headBucket_bucket :: Lens' HeadBucket BucketName Source #

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

HeadObject

headObject_checksumMode :: Lens' HeadObject (Maybe ChecksumMode) Source #

To retrieve the checksum, this parameter must be enabled.

In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

headObject_expectedBucketOwner :: Lens' HeadObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

headObject_ifMatch :: Lens' HeadObject (Maybe Text) Source #

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

headObject_ifModifiedSince :: Lens' HeadObject (Maybe UTCTime) Source #

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

headObject_ifNoneMatch :: Lens' HeadObject (Maybe Text) Source #

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

headObject_ifUnmodifiedSince :: Lens' HeadObject (Maybe UTCTime) Source #

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

headObject_partNumber :: Lens' HeadObject (Maybe Int) Source #

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

headObject_range :: Lens' HeadObject (Maybe Text) Source #

Because HeadObject returns only the metadata for an object, this parameter has no effect.

headObject_requestPayer :: Lens' HeadObject (Maybe RequestPayer) Source #

Undocumented member.

headObject_sSECustomerAlgorithm :: Lens' HeadObject (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

headObject_sSECustomerKey :: Lens' HeadObject (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

headObject_sSECustomerKeyMD5 :: Lens' HeadObject (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

headObject_versionId :: Lens' HeadObject (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

headObject_bucket :: Lens' HeadObject BucketName Source #

The name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

headObject_key :: Lens' HeadObject ObjectKey Source #

The object key.

headObjectResponse_acceptRanges :: Lens' HeadObjectResponse (Maybe Text) Source #

Indicates that a range of bytes was specified.

headObjectResponse_archiveStatus :: Lens' HeadObjectResponse (Maybe ArchiveStatus) Source #

The archive state of the head object.

headObjectResponse_bucketKeyEnabled :: Lens' HeadObjectResponse (Maybe Bool) Source #

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

headObjectResponse_cacheControl :: Lens' HeadObjectResponse (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

headObjectResponse_checksumCRC32 :: Lens' HeadObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

headObjectResponse_checksumCRC32C :: Lens' HeadObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

headObjectResponse_checksumSHA1 :: Lens' HeadObjectResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

headObjectResponse_checksumSHA256 :: Lens' HeadObjectResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

headObjectResponse_contentDisposition :: Lens' HeadObjectResponse (Maybe Text) Source #

Specifies presentational information for the object.

headObjectResponse_contentEncoding :: Lens' HeadObjectResponse (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

headObjectResponse_contentLanguage :: Lens' HeadObjectResponse (Maybe Text) Source #

The language the content is in.

headObjectResponse_contentLength :: Lens' HeadObjectResponse (Maybe Integer) Source #

Size of the body in bytes.

headObjectResponse_contentType :: Lens' HeadObjectResponse (Maybe Text) Source #

A standard MIME type describing the format of the object data.

headObjectResponse_deleteMarker :: Lens' HeadObjectResponse (Maybe Bool) Source #

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

headObjectResponse_eTag :: Lens' HeadObjectResponse (Maybe ETag) Source #

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

headObjectResponse_expiration :: Lens' HeadObjectResponse (Maybe Text) Source #

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

headObjectResponse_expires :: Lens' HeadObjectResponse (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable.

headObjectResponse_lastModified :: Lens' HeadObjectResponse (Maybe UTCTime) Source #

Creation date of the object.

headObjectResponse_metadata :: Lens' HeadObjectResponse (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

headObjectResponse_missingMeta :: Lens' HeadObjectResponse (Maybe Int) Source #

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

headObjectResponse_objectLockLegalHoldStatus :: Lens' HeadObjectResponse (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

headObjectResponse_objectLockMode :: Lens' HeadObjectResponse (Maybe ObjectLockMode) Source #

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

headObjectResponse_objectLockRetainUntilDate :: Lens' HeadObjectResponse (Maybe UTCTime) Source #

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

headObjectResponse_partsCount :: Lens' HeadObjectResponse (Maybe Int) Source #

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

headObjectResponse_replicationStatus :: Lens' HeadObjectResponse (Maybe ReplicationStatus) Source #

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

headObjectResponse_requestCharged :: Lens' HeadObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

headObjectResponse_restore :: Lens' HeadObjectResponse (Maybe Text) Source #

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

headObjectResponse_sSECustomerAlgorithm :: Lens' HeadObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

headObjectResponse_sSECustomerKeyMD5 :: Lens' HeadObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

headObjectResponse_sSEKMSKeyId :: Lens' HeadObjectResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

headObjectResponse_serverSideEncryption :: Lens' HeadObjectResponse (Maybe ServerSideEncryption) Source #

If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

headObjectResponse_storageClass :: Lens' HeadObjectResponse (Maybe StorageClass) Source #

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

headObjectResponse_versionId :: Lens' HeadObjectResponse (Maybe ObjectVersionId) Source #

Version of the object.

headObjectResponse_websiteRedirectLocation :: Lens' HeadObjectResponse (Maybe Text) Source #

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

headObjectResponse_httpStatus :: Lens' HeadObjectResponse Int Source #

The response's http status code.

ListBucketAnalyticsConfigurations

listBucketAnalyticsConfigurations_continuationToken :: Lens' ListBucketAnalyticsConfigurations (Maybe Text) Source #

The ContinuationToken that represents a placeholder from where this request should begin.

listBucketAnalyticsConfigurations_expectedBucketOwner :: Lens' ListBucketAnalyticsConfigurations (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listBucketAnalyticsConfigurations_bucket :: Lens' ListBucketAnalyticsConfigurations BucketName Source #

The name of the bucket from which analytics configurations are retrieved.

listBucketAnalyticsConfigurationsResponse_analyticsConfigurationList :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe [AnalyticsConfiguration]) Source #

The list of analytics configurations for a bucket.

listBucketAnalyticsConfigurationsResponse_continuationToken :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Text) Source #

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

listBucketAnalyticsConfigurationsResponse_isTruncated :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Bool) Source #

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

listBucketAnalyticsConfigurationsResponse_nextContinuationToken :: Lens' ListBucketAnalyticsConfigurationsResponse (Maybe Text) Source #

NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

listBucketAnalyticsConfigurationsResponse_httpStatus :: Lens' ListBucketAnalyticsConfigurationsResponse Int Source #

The response's http status code.

ListBucketIntelligentTieringConfigurations

listBucketIntelligentTieringConfigurations_continuationToken :: Lens' ListBucketIntelligentTieringConfigurations (Maybe Text) Source #

The ContinuationToken that represents a placeholder from where this request should begin.

listBucketIntelligentTieringConfigurations_bucket :: Lens' ListBucketIntelligentTieringConfigurations BucketName Source #

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

listBucketIntelligentTieringConfigurationsResponse_continuationToken :: Lens' ListBucketIntelligentTieringConfigurationsResponse (Maybe Text) Source #

The ContinuationToken that represents a placeholder from where this request should begin.

listBucketIntelligentTieringConfigurationsResponse_intelligentTieringConfigurationList :: Lens' ListBucketIntelligentTieringConfigurationsResponse (Maybe [IntelligentTieringConfiguration]) Source #

The list of S3 Intelligent-Tiering configurations for a bucket.

listBucketIntelligentTieringConfigurationsResponse_isTruncated :: Lens' ListBucketIntelligentTieringConfigurationsResponse (Maybe Bool) Source #

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

listBucketIntelligentTieringConfigurationsResponse_nextContinuationToken :: Lens' ListBucketIntelligentTieringConfigurationsResponse (Maybe Text) Source #

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

listBucketIntelligentTieringConfigurationsResponse_httpStatus :: Lens' ListBucketIntelligentTieringConfigurationsResponse Int Source #

The response's http status code.

ListBucketInventoryConfigurations

listBucketInventoryConfigurations_continuationToken :: Lens' ListBucketInventoryConfigurations (Maybe Text) Source #

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

listBucketInventoryConfigurations_expectedBucketOwner :: Lens' ListBucketInventoryConfigurations (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listBucketInventoryConfigurations_bucket :: Lens' ListBucketInventoryConfigurations BucketName Source #

The name of the bucket containing the inventory configurations to retrieve.

listBucketInventoryConfigurationsResponse_continuationToken :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Text) Source #

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

listBucketInventoryConfigurationsResponse_inventoryConfigurationList :: Lens' ListBucketInventoryConfigurationsResponse (Maybe [InventoryConfiguration]) Source #

The list of inventory configurations for a bucket.

listBucketInventoryConfigurationsResponse_isTruncated :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Bool) Source #

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

listBucketInventoryConfigurationsResponse_nextContinuationToken :: Lens' ListBucketInventoryConfigurationsResponse (Maybe Text) Source #

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

listBucketInventoryConfigurationsResponse_httpStatus :: Lens' ListBucketInventoryConfigurationsResponse Int Source #

The response's http status code.

ListBucketMetricsConfigurations

listBucketMetricsConfigurations_continuationToken :: Lens' ListBucketMetricsConfigurations (Maybe Text) Source #

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

listBucketMetricsConfigurations_expectedBucketOwner :: Lens' ListBucketMetricsConfigurations (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listBucketMetricsConfigurations_bucket :: Lens' ListBucketMetricsConfigurations BucketName Source #

The name of the bucket containing the metrics configurations to retrieve.

listBucketMetricsConfigurationsResponse_continuationToken :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Text) Source #

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

listBucketMetricsConfigurationsResponse_isTruncated :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Bool) Source #

Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

listBucketMetricsConfigurationsResponse_metricsConfigurationList :: Lens' ListBucketMetricsConfigurationsResponse (Maybe [MetricsConfiguration]) Source #

The list of metrics configurations for a bucket.

listBucketMetricsConfigurationsResponse_nextContinuationToken :: Lens' ListBucketMetricsConfigurationsResponse (Maybe Text) Source #

The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

listBucketMetricsConfigurationsResponse_httpStatus :: Lens' ListBucketMetricsConfigurationsResponse Int Source #

The response's http status code.

ListBuckets

listBucketsResponse_buckets :: Lens' ListBucketsResponse (Maybe [Bucket]) Source #

The list of buckets owned by the requester.

listBucketsResponse_owner :: Lens' ListBucketsResponse (Maybe Owner) Source #

The owner of the buckets listed.

listBucketsResponse_httpStatus :: Lens' ListBucketsResponse Int Source #

The response's http status code.

ListMultipartUploads

listMultipartUploads_delimiter :: Lens' ListMultipartUploads (Maybe Delimiter) Source #

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

listMultipartUploads_encodingType :: Lens' ListMultipartUploads (Maybe EncodingType) Source #

Undocumented member.

listMultipartUploads_expectedBucketOwner :: Lens' ListMultipartUploads (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listMultipartUploads_keyMarker :: Lens' ListMultipartUploads (Maybe Text) Source #

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

listMultipartUploads_maxUploads :: Lens' ListMultipartUploads (Maybe Int) Source #

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

listMultipartUploads_prefix :: Lens' ListMultipartUploads (Maybe Text) Source #

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

listMultipartUploads_uploadIdMarker :: Lens' ListMultipartUploads (Maybe Text) Source #

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

listMultipartUploads_bucket :: Lens' ListMultipartUploads BucketName Source #

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

listMultipartUploadsResponse_bucket :: Lens' ListMultipartUploadsResponse (Maybe BucketName) Source #

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

listMultipartUploadsResponse_commonPrefixes :: Lens' ListMultipartUploadsResponse (Maybe [CommonPrefix]) Source #

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

listMultipartUploadsResponse_delimiter :: Lens' ListMultipartUploadsResponse (Maybe Delimiter) Source #

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

listMultipartUploadsResponse_encodingType :: Lens' ListMultipartUploadsResponse (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

listMultipartUploadsResponse_isTruncated :: Lens' ListMultipartUploadsResponse (Maybe Bool) Source #

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

listMultipartUploadsResponse_keyMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

The key at or after which the listing began.

listMultipartUploadsResponse_maxUploads :: Lens' ListMultipartUploadsResponse (Maybe Int) Source #

Maximum number of multipart uploads that could have been included in the response.

listMultipartUploadsResponse_nextKeyMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

listMultipartUploadsResponse_nextUploadIdMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

listMultipartUploadsResponse_prefix :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

listMultipartUploadsResponse_uploadIdMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

Upload ID after which listing began.

listMultipartUploadsResponse_uploads :: Lens' ListMultipartUploadsResponse (Maybe [MultipartUpload]) Source #

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

listMultipartUploadsResponse_httpStatus :: Lens' ListMultipartUploadsResponse Int Source #

The response's http status code.

ListObjectVersions

listObjectVersions_delimiter :: Lens' ListObjectVersions (Maybe Delimiter) Source #

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

listObjectVersions_encodingType :: Lens' ListObjectVersions (Maybe EncodingType) Source #

Undocumented member.

listObjectVersions_expectedBucketOwner :: Lens' ListObjectVersions (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listObjectVersions_keyMarker :: Lens' ListObjectVersions (Maybe Text) Source #

Specifies the key to start with when listing objects in a bucket.

listObjectVersions_maxKeys :: Lens' ListObjectVersions (Maybe Int) Source #

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

listObjectVersions_prefix :: Lens' ListObjectVersions (Maybe Text) Source #

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

listObjectVersions_versionIdMarker :: Lens' ListObjectVersions (Maybe Text) Source #

Specifies the object version you want to start listing from.

listObjectVersions_bucket :: Lens' ListObjectVersions BucketName Source #

The bucket name that contains the objects.

listObjectVersionsResponse_commonPrefixes :: Lens' ListObjectVersionsResponse (Maybe [CommonPrefix]) Source #

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

listObjectVersionsResponse_deleteMarkers :: Lens' ListObjectVersionsResponse (Maybe [DeleteMarkerEntry]) Source #

Container for an object that is a delete marker.

listObjectVersionsResponse_delimiter :: Lens' ListObjectVersionsResponse (Maybe Delimiter) Source #

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

listObjectVersionsResponse_encodingType :: Lens' ListObjectVersionsResponse (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

listObjectVersionsResponse_isTruncated :: Lens' ListObjectVersionsResponse (Maybe Bool) Source #

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

listObjectVersionsResponse_keyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Marks the last key returned in a truncated response.

listObjectVersionsResponse_maxKeys :: Lens' ListObjectVersionsResponse (Maybe Int) Source #

Specifies the maximum number of objects to return.

listObjectVersionsResponse_name :: Lens' ListObjectVersionsResponse (Maybe BucketName) Source #

The bucket name.

listObjectVersionsResponse_nextKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

listObjectVersionsResponse_nextVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

listObjectVersionsResponse_prefix :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Selects objects that start with the value supplied by this parameter.

listObjectVersionsResponse_versionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Marks the last version of the key returned in a truncated response.

listObjectVersionsResponse_versions :: Lens' ListObjectVersionsResponse (Maybe [ObjectVersion]) Source #

Container for version information.

listObjectVersionsResponse_httpStatus :: Lens' ListObjectVersionsResponse Int Source #

The response's http status code.

ListObjects

listObjects_delimiter :: Lens' ListObjects (Maybe Delimiter) Source #

A delimiter is a character you use to group keys.

listObjects_encodingType :: Lens' ListObjects (Maybe EncodingType) Source #

Undocumented member.

listObjects_expectedBucketOwner :: Lens' ListObjects (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listObjects_marker :: Lens' ListObjects (Maybe Text) Source #

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

listObjects_maxKeys :: Lens' ListObjects (Maybe Int) Source #

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

listObjects_prefix :: Lens' ListObjects (Maybe Text) Source #

Limits the response to keys that begin with the specified prefix.

listObjects_requestPayer :: Lens' ListObjects (Maybe RequestPayer) Source #

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

listObjects_bucket :: Lens' ListObjects BucketName Source #

The name of the bucket containing the objects.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

listObjectsResponse_commonPrefixes :: Lens' ListObjectsResponse (Maybe [CommonPrefix]) Source #

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

listObjectsResponse_contents :: Lens' ListObjectsResponse (Maybe [Object]) Source #

Metadata about each object returned.

listObjectsResponse_delimiter :: Lens' ListObjectsResponse (Maybe Delimiter) Source #

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

listObjectsResponse_encodingType :: Lens' ListObjectsResponse (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object keys in the response.

listObjectsResponse_isTruncated :: Lens' ListObjectsResponse (Maybe Bool) Source #

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

listObjectsResponse_marker :: Lens' ListObjectsResponse (Maybe Text) Source #

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

listObjectsResponse_maxKeys :: Lens' ListObjectsResponse (Maybe Int) Source #

The maximum number of keys returned in the response body.

listObjectsResponse_name :: Lens' ListObjectsResponse (Maybe BucketName) Source #

The bucket name.

listObjectsResponse_nextMarker :: Lens' ListObjectsResponse (Maybe Text) Source #

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

listObjectsResponse_prefix :: Lens' ListObjectsResponse (Maybe Text) Source #

Keys that begin with the indicated prefix.

listObjectsResponse_httpStatus :: Lens' ListObjectsResponse Int Source #

The response's http status code.

ListObjectsV2

listObjectsV2_continuationToken :: Lens' ListObjectsV2 (Maybe Text) Source #

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

listObjectsV2_delimiter :: Lens' ListObjectsV2 (Maybe Delimiter) Source #

A delimiter is a character you use to group keys.

listObjectsV2_encodingType :: Lens' ListObjectsV2 (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object keys in the response.

listObjectsV2_expectedBucketOwner :: Lens' ListObjectsV2 (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listObjectsV2_fetchOwner :: Lens' ListObjectsV2 (Maybe Bool) Source #

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

listObjectsV2_maxKeys :: Lens' ListObjectsV2 (Maybe Int) Source #

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

listObjectsV2_prefix :: Lens' ListObjectsV2 (Maybe Text) Source #

Limits the response to keys that begin with the specified prefix.

listObjectsV2_requestPayer :: Lens' ListObjectsV2 (Maybe RequestPayer) Source #

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

listObjectsV2_startAfter :: Lens' ListObjectsV2 (Maybe Text) Source #

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

listObjectsV2_bucket :: Lens' ListObjectsV2 BucketName Source #

Bucket name to list.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

listObjectsV2Response_commonPrefixes :: Lens' ListObjectsV2Response (Maybe [CommonPrefix]) Source #

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

listObjectsV2Response_contents :: Lens' ListObjectsV2Response (Maybe [Object]) Source #

Metadata about each object returned.

listObjectsV2Response_continuationToken :: Lens' ListObjectsV2Response (Maybe Text) Source #

If ContinuationToken was sent with the request, it is included in the response.

listObjectsV2Response_delimiter :: Lens' ListObjectsV2Response (Maybe Delimiter) Source #

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

listObjectsV2Response_encodingType :: Lens' ListObjectsV2Response (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

listObjectsV2Response_isTruncated :: Lens' ListObjectsV2Response (Maybe Bool) Source #

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

listObjectsV2Response_keyCount :: Lens' ListObjectsV2Response (Maybe Int) Source #

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

listObjectsV2Response_maxKeys :: Lens' ListObjectsV2Response (Maybe Int) Source #

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

listObjectsV2Response_name :: Lens' ListObjectsV2Response (Maybe BucketName) Source #

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

listObjectsV2Response_nextContinuationToken :: Lens' ListObjectsV2Response (Maybe Text) Source #

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

listObjectsV2Response_prefix :: Lens' ListObjectsV2Response (Maybe Text) Source #

Keys that begin with the indicated prefix.

listObjectsV2Response_startAfter :: Lens' ListObjectsV2Response (Maybe Text) Source #

If StartAfter was sent with the request, it is included in the response.

listObjectsV2Response_httpStatus :: Lens' ListObjectsV2Response Int Source #

The response's http status code.

ListParts

listParts_expectedBucketOwner :: Lens' ListParts (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

listParts_maxParts :: Lens' ListParts (Maybe Int) Source #

Sets the maximum number of parts to return.

listParts_partNumberMarker :: Lens' ListParts (Maybe Int) Source #

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

listParts_requestPayer :: Lens' ListParts (Maybe RequestPayer) Source #

Undocumented member.

listParts_sSECustomerAlgorithm :: Lens' ListParts (Maybe Text) Source #

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

listParts_sSECustomerKey :: Lens' ListParts (Maybe Text) Source #

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

listParts_sSECustomerKeyMD5 :: Lens' ListParts (Maybe Text) Source #

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

listParts_bucket :: Lens' ListParts BucketName Source #

The name of the bucket to which the parts are being uploaded.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

listParts_key :: Lens' ListParts ObjectKey Source #

Object key for which the multipart upload was initiated.

listParts_uploadId :: Lens' ListParts Text Source #

Upload ID identifying the multipart upload whose parts are being listed.

listPartsResponse_abortDate :: Lens' ListPartsResponse (Maybe UTCTime) Source #

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

listPartsResponse_abortRuleId :: Lens' ListPartsResponse (Maybe Text) Source #

This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

listPartsResponse_bucket :: Lens' ListPartsResponse (Maybe BucketName) Source #

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

listPartsResponse_checksumAlgorithm :: Lens' ListPartsResponse (Maybe ChecksumAlgorithm) Source #

The algorithm that was used to create a checksum of the object.

listPartsResponse_initiator :: Lens' ListPartsResponse (Maybe Initiator) Source #

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

listPartsResponse_isTruncated :: Lens' ListPartsResponse (Maybe Bool) Source #

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

listPartsResponse_key :: Lens' ListPartsResponse (Maybe ObjectKey) Source #

Object key for which the multipart upload was initiated.

listPartsResponse_maxParts :: Lens' ListPartsResponse (Maybe Int) Source #

Maximum number of parts that were allowed in the response.

listPartsResponse_nextPartNumberMarker :: Lens' ListPartsResponse (Maybe Int) Source #

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

listPartsResponse_owner :: Lens' ListPartsResponse (Maybe Owner) Source #

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

listPartsResponse_partNumberMarker :: Lens' ListPartsResponse (Maybe Int) Source #

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

listPartsResponse_parts :: Lens' ListPartsResponse (Maybe [Part]) Source #

Container for elements related to a particular part. A response can contain zero or more Part elements.

listPartsResponse_requestCharged :: Lens' ListPartsResponse (Maybe RequestCharged) Source #

Undocumented member.

listPartsResponse_storageClass :: Lens' ListPartsResponse (Maybe StorageClass) Source #

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

listPartsResponse_uploadId :: Lens' ListPartsResponse (Maybe Text) Source #

Upload ID identifying the multipart upload whose parts are being listed.

listPartsResponse_httpStatus :: Lens' ListPartsResponse Int Source #

The response's http status code.

PutBucketAccelerateConfiguration

putBucketAccelerateConfiguration_checksumAlgorithm :: Lens' PutBucketAccelerateConfiguration (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketAccelerateConfiguration_expectedBucketOwner :: Lens' PutBucketAccelerateConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketAccelerateConfiguration_bucket :: Lens' PutBucketAccelerateConfiguration BucketName Source #

The name of the bucket for which the accelerate configuration is set.

putBucketAccelerateConfiguration_accelerateConfiguration :: Lens' PutBucketAccelerateConfiguration AccelerateConfiguration Source #

Container for setting the transfer acceleration state.

PutBucketAcl

putBucketAcl_acl :: Lens' PutBucketAcl (Maybe BucketCannedACL) Source #

The canned ACL to apply to the bucket.

putBucketAcl_accessControlPolicy :: Lens' PutBucketAcl (Maybe AccessControlPolicy) Source #

Contains the elements that set the ACL permissions for an object per grantee.

putBucketAcl_checksumAlgorithm :: Lens' PutBucketAcl (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketAcl_contentMD5 :: Lens' PutBucketAcl (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketAcl_expectedBucketOwner :: Lens' PutBucketAcl (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketAcl_grantFullControl :: Lens' PutBucketAcl (Maybe Text) Source #

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

putBucketAcl_grantRead :: Lens' PutBucketAcl (Maybe Text) Source #

Allows grantee to list the objects in the bucket.

putBucketAcl_grantReadACP :: Lens' PutBucketAcl (Maybe Text) Source #

Allows grantee to read the bucket ACL.

putBucketAcl_grantWrite :: Lens' PutBucketAcl (Maybe Text) Source #

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

putBucketAcl_grantWriteACP :: Lens' PutBucketAcl (Maybe Text) Source #

Allows grantee to write the ACL for the applicable bucket.

putBucketAcl_bucket :: Lens' PutBucketAcl BucketName Source #

The bucket to which to apply the ACL.

PutBucketAnalyticsConfiguration

putBucketAnalyticsConfiguration_expectedBucketOwner :: Lens' PutBucketAnalyticsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketAnalyticsConfiguration_bucket :: Lens' PutBucketAnalyticsConfiguration BucketName Source #

The name of the bucket to which an analytics configuration is stored.

putBucketAnalyticsConfiguration_id :: Lens' PutBucketAnalyticsConfiguration Text Source #

The ID that identifies the analytics configuration.

putBucketAnalyticsConfiguration_analyticsConfiguration :: Lens' PutBucketAnalyticsConfiguration AnalyticsConfiguration Source #

The configuration and any analyses for the analytics filter.

PutBucketCors

putBucketCors_checksumAlgorithm :: Lens' PutBucketCors (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketCors_contentMD5 :: Lens' PutBucketCors (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketCors_expectedBucketOwner :: Lens' PutBucketCors (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketCors_bucket :: Lens' PutBucketCors BucketName Source #

Specifies the bucket impacted by the corsconfiguration.

putBucketCors_cORSConfiguration :: Lens' PutBucketCors CORSConfiguration Source #

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

PutBucketEncryption

putBucketEncryption_checksumAlgorithm :: Lens' PutBucketEncryption (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketEncryption_contentMD5 :: Lens' PutBucketEncryption (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketEncryption_expectedBucketOwner :: Lens' PutBucketEncryption (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketEncryption_bucket :: Lens' PutBucketEncryption BucketName Source #

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

putBucketEncryption_serverSideEncryptionConfiguration :: Lens' PutBucketEncryption ServerSideEncryptionConfiguration Source #

Undocumented member.

PutBucketIntelligentTieringConfiguration

putBucketIntelligentTieringConfiguration_bucket :: Lens' PutBucketIntelligentTieringConfiguration BucketName Source #

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

putBucketIntelligentTieringConfiguration_id :: Lens' PutBucketIntelligentTieringConfiguration Text Source #

The ID used to identify the S3 Intelligent-Tiering configuration.

putBucketIntelligentTieringConfiguration_intelligentTieringConfiguration :: Lens' PutBucketIntelligentTieringConfiguration IntelligentTieringConfiguration Source #

Container for S3 Intelligent-Tiering configuration.

PutBucketInventoryConfiguration

putBucketInventoryConfiguration_expectedBucketOwner :: Lens' PutBucketInventoryConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketInventoryConfiguration_bucket :: Lens' PutBucketInventoryConfiguration BucketName Source #

The name of the bucket where the inventory configuration will be stored.

putBucketInventoryConfiguration_id :: Lens' PutBucketInventoryConfiguration Text Source #

The ID used to identify the inventory configuration.

putBucketInventoryConfiguration_inventoryConfiguration :: Lens' PutBucketInventoryConfiguration InventoryConfiguration Source #

Specifies the inventory configuration.

PutBucketLifecycleConfiguration

putBucketLifecycleConfiguration_checksumAlgorithm :: Lens' PutBucketLifecycleConfiguration (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketLifecycleConfiguration_expectedBucketOwner :: Lens' PutBucketLifecycleConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketLifecycleConfiguration_lifecycleConfiguration :: Lens' PutBucketLifecycleConfiguration (Maybe BucketLifecycleConfiguration) Source #

Container for lifecycle rules. You can add as many as 1,000 rules.

putBucketLifecycleConfiguration_bucket :: Lens' PutBucketLifecycleConfiguration BucketName Source #

The name of the bucket for which to set the configuration.

PutBucketLogging

putBucketLogging_checksumAlgorithm :: Lens' PutBucketLogging (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketLogging_contentMD5 :: Lens' PutBucketLogging (Maybe Text) Source #

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketLogging_expectedBucketOwner :: Lens' PutBucketLogging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketLogging_bucket :: Lens' PutBucketLogging BucketName Source #

The name of the bucket for which to set the logging parameters.

putBucketLogging_bucketLoggingStatus :: Lens' PutBucketLogging BucketLoggingStatus Source #

Container for logging status information.

PutBucketMetricsConfiguration

putBucketMetricsConfiguration_expectedBucketOwner :: Lens' PutBucketMetricsConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketMetricsConfiguration_bucket :: Lens' PutBucketMetricsConfiguration BucketName Source #

The name of the bucket for which the metrics configuration is set.

putBucketMetricsConfiguration_id :: Lens' PutBucketMetricsConfiguration Text Source #

The ID used to identify the metrics configuration.

putBucketMetricsConfiguration_metricsConfiguration :: Lens' PutBucketMetricsConfiguration MetricsConfiguration Source #

Specifies the metrics configuration.

PutBucketNotificationConfiguration

putBucketNotificationConfiguration_expectedBucketOwner :: Lens' PutBucketNotificationConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketNotificationConfiguration_skipDestinationValidation :: Lens' PutBucketNotificationConfiguration (Maybe Bool) Source #

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

putBucketNotificationConfiguration_bucket :: Lens' PutBucketNotificationConfiguration BucketName Source #

The name of the bucket.

putBucketNotificationConfiguration_notificationConfiguration :: Lens' PutBucketNotificationConfiguration NotificationConfiguration Source #

Undocumented member.

PutBucketOwnershipControls

putBucketOwnershipControls_contentMD5 :: Lens' PutBucketOwnershipControls (Maybe Text) Source #

The MD5 hash of the OwnershipControls request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketOwnershipControls_expectedBucketOwner :: Lens' PutBucketOwnershipControls (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketOwnershipControls_bucket :: Lens' PutBucketOwnershipControls BucketName Source #

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

putBucketOwnershipControls_ownershipControls :: Lens' PutBucketOwnershipControls OwnershipControls Source #

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

PutBucketPolicy

putBucketPolicy_checksumAlgorithm :: Lens' PutBucketPolicy (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketPolicy_confirmRemoveSelfBucketAccess :: Lens' PutBucketPolicy (Maybe Bool) Source #

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

putBucketPolicy_contentMD5 :: Lens' PutBucketPolicy (Maybe Text) Source #

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketPolicy_expectedBucketOwner :: Lens' PutBucketPolicy (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketPolicy_bucket :: Lens' PutBucketPolicy BucketName Source #

The name of the bucket.

putBucketPolicy_policy :: Lens' PutBucketPolicy ByteString Source #

The bucket policy as a JSON document.

PutBucketReplication

putBucketReplication_checksumAlgorithm :: Lens' PutBucketReplication (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketReplication_contentMD5 :: Lens' PutBucketReplication (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketReplication_expectedBucketOwner :: Lens' PutBucketReplication (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketReplication_token :: Lens' PutBucketReplication (Maybe Text) Source #

A token to allow Object Lock to be enabled for an existing bucket.

putBucketReplication_bucket :: Lens' PutBucketReplication BucketName Source #

The name of the bucket

putBucketReplication_replicationConfiguration :: Lens' PutBucketReplication ReplicationConfiguration Source #

Undocumented member.

PutBucketRequestPayment

putBucketRequestPayment_checksumAlgorithm :: Lens' PutBucketRequestPayment (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketRequestPayment_contentMD5 :: Lens' PutBucketRequestPayment (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketRequestPayment_expectedBucketOwner :: Lens' PutBucketRequestPayment (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketRequestPayment_bucket :: Lens' PutBucketRequestPayment BucketName Source #

The bucket name.

putBucketRequestPayment_requestPaymentConfiguration :: Lens' PutBucketRequestPayment RequestPaymentConfiguration Source #

Container for Payer.

PutBucketTagging

putBucketTagging_checksumAlgorithm :: Lens' PutBucketTagging (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketTagging_contentMD5 :: Lens' PutBucketTagging (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketTagging_expectedBucketOwner :: Lens' PutBucketTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketTagging_bucket :: Lens' PutBucketTagging BucketName Source #

The bucket name.

putBucketTagging_tagging :: Lens' PutBucketTagging Tagging Source #

Container for the TagSet and Tag elements.

PutBucketVersioning

putBucketVersioning_checksumAlgorithm :: Lens' PutBucketVersioning (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketVersioning_contentMD5 :: Lens' PutBucketVersioning (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this

header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketVersioning_expectedBucketOwner :: Lens' PutBucketVersioning (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketVersioning_mfa :: Lens' PutBucketVersioning (Maybe Text) Source #

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

putBucketVersioning_bucket :: Lens' PutBucketVersioning BucketName Source #

The bucket name.

putBucketVersioning_versioningConfiguration :: Lens' PutBucketVersioning VersioningConfiguration Source #

Container for setting the versioning state.

PutBucketWebsite

putBucketWebsite_checksumAlgorithm :: Lens' PutBucketWebsite (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketWebsite_contentMD5 :: Lens' PutBucketWebsite (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketWebsite_expectedBucketOwner :: Lens' PutBucketWebsite (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketWebsite_bucket :: Lens' PutBucketWebsite BucketName Source #

The bucket name.

putBucketWebsite_websiteConfiguration :: Lens' PutBucketWebsite WebsiteConfiguration Source #

Container for the request.

PutObject

putObject_acl :: Lens' PutObject (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

putObject_bucketKeyEnabled :: Lens' PutObject (Maybe Bool) Source #

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

putObject_cacheControl :: Lens' PutObject (Maybe Text) Source #

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

putObject_checksumAlgorithm :: Lens' PutObject (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObject_checksumCRC32 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumCRC32C :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumSHA1 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumSHA256 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_contentDisposition :: Lens' PutObject (Maybe Text) Source #

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

putObject_contentEncoding :: Lens' PutObject (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

putObject_contentLanguage :: Lens' PutObject (Maybe Text) Source #

The language the content is in.

putObject_contentLength :: Lens' PutObject (Maybe Integer) Source #

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

putObject_contentMD5 :: Lens' PutObject (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

putObject_contentType :: Lens' PutObject (Maybe Text) Source #

A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

putObject_expectedBucketOwner :: Lens' PutObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObject_expires :: Lens' PutObject (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

putObject_grantFullControl :: Lens' PutObject (Maybe Text) Source #

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

putObject_grantRead :: Lens' PutObject (Maybe Text) Source #

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

putObject_grantReadACP :: Lens' PutObject (Maybe Text) Source #

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

putObject_grantWriteACP :: Lens' PutObject (Maybe Text) Source #

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

putObject_metadata :: Lens' PutObject (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

putObject_objectLockLegalHoldStatus :: Lens' PutObject (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

putObject_objectLockMode :: Lens' PutObject (Maybe ObjectLockMode) Source #

The Object Lock mode that you want to apply to this object.

putObject_objectLockRetainUntilDate :: Lens' PutObject (Maybe UTCTime) Source #

The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

putObject_requestPayer :: Lens' PutObject (Maybe RequestPayer) Source #

Undocumented member.

putObject_sSECustomerAlgorithm :: Lens' PutObject (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

putObject_sSECustomerKey :: Lens' PutObject (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

putObject_sSECustomerKeyMD5 :: Lens' PutObject (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

putObject_sSEKMSEncryptionContext :: Lens' PutObject (Maybe Text) Source #

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

putObject_sSEKMSKeyId :: Lens' PutObject (Maybe Text) Source #

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

putObject_serverSideEncryption :: Lens' PutObject (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

putObject_storageClass :: Lens' PutObject (Maybe StorageClass) Source #

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

putObject_tagging :: Lens' PutObject (Maybe Text) Source #

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

putObject_websiteRedirectLocation :: Lens' PutObject (Maybe Text) Source #

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

putObject_bucket :: Lens' PutObject BucketName Source #

The bucket name to which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

putObject_key :: Lens' PutObject ObjectKey Source #

Object key for which the PUT action was initiated.

putObject_body :: Lens' PutObject RequestBody Source #

Object data.

putObjectResponse_bucketKeyEnabled :: Lens' PutObjectResponse (Maybe Bool) Source #

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

putObjectResponse_checksumCRC32 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumCRC32C :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumSHA1 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumSHA256 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_eTag :: Lens' PutObjectResponse (Maybe ETag) Source #

Entity tag for the uploaded object.

putObjectResponse_expiration :: Lens' PutObjectResponse (Maybe Text) Source #

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

putObjectResponse_requestCharged :: Lens' PutObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectResponse_sSECustomerAlgorithm :: Lens' PutObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

putObjectResponse_sSECustomerKeyMD5 :: Lens' PutObjectResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

putObjectResponse_sSEKMSEncryptionContext :: Lens' PutObjectResponse (Maybe Text) Source #

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

putObjectResponse_sSEKMSKeyId :: Lens' PutObjectResponse (Maybe Text) Source #

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

putObjectResponse_serverSideEncryption :: Lens' PutObjectResponse (Maybe ServerSideEncryption) Source #

If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

putObjectResponse_versionId :: Lens' PutObjectResponse (Maybe ObjectVersionId) Source #

Version of the object.

putObjectResponse_httpStatus :: Lens' PutObjectResponse Int Source #

The response's http status code.

PutObjectAcl

putObjectAcl_acl :: Lens' PutObjectAcl (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object. For more information, see Canned ACL.

putObjectAcl_accessControlPolicy :: Lens' PutObjectAcl (Maybe AccessControlPolicy) Source #

Contains the elements that set the ACL permissions for an object per grantee.

putObjectAcl_checksumAlgorithm :: Lens' PutObjectAcl (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObjectAcl_contentMD5 :: Lens' PutObjectAcl (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectAcl_expectedBucketOwner :: Lens' PutObjectAcl (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObjectAcl_grantFullControl :: Lens' PutObjectAcl (Maybe Text) Source #

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This action is not supported by Amazon S3 on Outposts.

putObjectAcl_grantRead :: Lens' PutObjectAcl (Maybe Text) Source #

Allows grantee to list the objects in the bucket.

This action is not supported by Amazon S3 on Outposts.

putObjectAcl_grantReadACP :: Lens' PutObjectAcl (Maybe Text) Source #

Allows grantee to read the bucket ACL.

This action is not supported by Amazon S3 on Outposts.

putObjectAcl_grantWrite :: Lens' PutObjectAcl (Maybe Text) Source #

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

putObjectAcl_grantWriteACP :: Lens' PutObjectAcl (Maybe Text) Source #

Allows grantee to write the ACL for the applicable bucket.

This action is not supported by Amazon S3 on Outposts.

putObjectAcl_requestPayer :: Lens' PutObjectAcl (Maybe RequestPayer) Source #

Undocumented member.

putObjectAcl_versionId :: Lens' PutObjectAcl (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

putObjectAcl_bucket :: Lens' PutObjectAcl BucketName Source #

The bucket name that contains the object to which you want to attach the ACL.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

putObjectAcl_key :: Lens' PutObjectAcl ObjectKey Source #

Key for which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

putObjectAclResponse_requestCharged :: Lens' PutObjectAclResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectAclResponse_httpStatus :: Lens' PutObjectAclResponse Int Source #

The response's http status code.

PutObjectLegalHold

putObjectLegalHold_checksumAlgorithm :: Lens' PutObjectLegalHold (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObjectLegalHold_contentMD5 :: Lens' PutObjectLegalHold (Maybe Text) Source #

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectLegalHold_expectedBucketOwner :: Lens' PutObjectLegalHold (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObjectLegalHold_legalHold :: Lens' PutObjectLegalHold (Maybe ObjectLockLegalHold) Source #

Container element for the legal hold configuration you want to apply to the specified object.

putObjectLegalHold_requestPayer :: Lens' PutObjectLegalHold (Maybe RequestPayer) Source #

Undocumented member.

putObjectLegalHold_versionId :: Lens' PutObjectLegalHold (Maybe ObjectVersionId) Source #

The version ID of the object that you want to place a legal hold on.

putObjectLegalHold_bucket :: Lens' PutObjectLegalHold BucketName Source #

The bucket name containing the object that you want to place a legal hold on.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

putObjectLegalHold_key :: Lens' PutObjectLegalHold ObjectKey Source #

The key name for the object that you want to place a legal hold on.

putObjectLegalHoldResponse_requestCharged :: Lens' PutObjectLegalHoldResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectLegalHoldResponse_httpStatus :: Lens' PutObjectLegalHoldResponse Int Source #

The response's http status code.

PutObjectLockConfiguration

putObjectLockConfiguration_checksumAlgorithm :: Lens' PutObjectLockConfiguration (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObjectLockConfiguration_contentMD5 :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectLockConfiguration_expectedBucketOwner :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObjectLockConfiguration_objectLockConfiguration :: Lens' PutObjectLockConfiguration (Maybe ObjectLockConfiguration) Source #

The Object Lock configuration that you want to apply to the specified bucket.

putObjectLockConfiguration_requestPayer :: Lens' PutObjectLockConfiguration (Maybe RequestPayer) Source #

Undocumented member.

putObjectLockConfiguration_token :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

A token to allow Object Lock to be enabled for an existing bucket.

putObjectLockConfiguration_bucket :: Lens' PutObjectLockConfiguration BucketName Source #

The bucket whose Object Lock configuration you want to create or replace.

putObjectLockConfigurationResponse_requestCharged :: Lens' PutObjectLockConfigurationResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectLockConfigurationResponse_httpStatus :: Lens' PutObjectLockConfigurationResponse Int Source #

The response's http status code.

PutObjectRetention

putObjectRetention_bypassGovernanceRetention :: Lens' PutObjectRetention (Maybe Bool) Source #

Indicates whether this action should bypass Governance-mode restrictions.

putObjectRetention_checksumAlgorithm :: Lens' PutObjectRetention (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObjectRetention_contentMD5 :: Lens' PutObjectRetention (Maybe Text) Source #

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectRetention_expectedBucketOwner :: Lens' PutObjectRetention (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObjectRetention_requestPayer :: Lens' PutObjectRetention (Maybe RequestPayer) Source #

Undocumented member.

putObjectRetention_retention :: Lens' PutObjectRetention (Maybe ObjectLockRetention) Source #

The container element for the Object Retention configuration.

putObjectRetention_versionId :: Lens' PutObjectRetention (Maybe ObjectVersionId) Source #

The version ID for the object that you want to apply this Object Retention configuration to.

putObjectRetention_bucket :: Lens' PutObjectRetention BucketName Source #

The bucket name that contains the object you want to apply this Object Retention configuration to.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

putObjectRetention_key :: Lens' PutObjectRetention ObjectKey Source #

The key name for the object that you want to apply this Object Retention configuration to.

putObjectRetentionResponse_requestCharged :: Lens' PutObjectRetentionResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectRetentionResponse_httpStatus :: Lens' PutObjectRetentionResponse Int Source #

The response's http status code.

PutObjectTagging

putObjectTagging_checksumAlgorithm :: Lens' PutObjectTagging (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObjectTagging_contentMD5 :: Lens' PutObjectTagging (Maybe Text) Source #

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectTagging_expectedBucketOwner :: Lens' PutObjectTagging (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObjectTagging_requestPayer :: Lens' PutObjectTagging (Maybe RequestPayer) Source #

Undocumented member.

putObjectTagging_versionId :: Lens' PutObjectTagging (Maybe ObjectVersionId) Source #

The versionId of the object that the tag-set will be added to.

putObjectTagging_bucket :: Lens' PutObjectTagging BucketName Source #

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

putObjectTagging_key :: Lens' PutObjectTagging ObjectKey Source #

Name of the object key.

putObjectTagging_tagging :: Lens' PutObjectTagging Tagging Source #

Container for the TagSet and Tag elements

putObjectTaggingResponse_versionId :: Lens' PutObjectTaggingResponse (Maybe ObjectVersionId) Source #

The versionId of the object the tag-set was added to.

putObjectTaggingResponse_httpStatus :: Lens' PutObjectTaggingResponse Int Source #

The response's http status code.

PutPublicAccessBlock

putPublicAccessBlock_checksumAlgorithm :: Lens' PutPublicAccessBlock (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putPublicAccessBlock_contentMD5 :: Lens' PutPublicAccessBlock (Maybe Text) Source #

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putPublicAccessBlock_expectedBucketOwner :: Lens' PutPublicAccessBlock (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putPublicAccessBlock_bucket :: Lens' PutPublicAccessBlock BucketName Source #

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

putPublicAccessBlock_publicAccessBlockConfiguration :: Lens' PutPublicAccessBlock PublicAccessBlockConfiguration Source #

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

RestoreObject

restoreObject_checksumAlgorithm :: Lens' RestoreObject (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

restoreObject_expectedBucketOwner :: Lens' RestoreObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

restoreObject_requestPayer :: Lens' RestoreObject (Maybe RequestPayer) Source #

Undocumented member.

restoreObject_restoreRequest :: Lens' RestoreObject (Maybe RestoreRequest) Source #

Undocumented member.

restoreObject_versionId :: Lens' RestoreObject (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

restoreObject_bucket :: Lens' RestoreObject BucketName Source #

The bucket name containing the object to restore.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

restoreObject_key :: Lens' RestoreObject ObjectKey Source #

Object key for which the action was initiated.

restoreObjectResponse_requestCharged :: Lens' RestoreObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

restoreObjectResponse_restoreOutputPath :: Lens' RestoreObjectResponse (Maybe Text) Source #

Indicates the path in the provided S3 output location where Select results will be restored to.

restoreObjectResponse_httpStatus :: Lens' RestoreObjectResponse Int Source #

The response's http status code.

SelectObjectContent

selectObjectContent_expectedBucketOwner :: Lens' SelectObjectContent (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

selectObjectContent_requestProgress :: Lens' SelectObjectContent (Maybe RequestProgress) Source #

Specifies if periodic request progress information should be enabled.

selectObjectContent_sSECustomerAlgorithm :: Lens' SelectObjectContent (Maybe Text) Source #

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

selectObjectContent_sSECustomerKey :: Lens' SelectObjectContent (Maybe Text) Source #

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

selectObjectContent_sSECustomerKeyMD5 :: Lens' SelectObjectContent (Maybe Text) Source #

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

selectObjectContent_scanRange :: Lens' SelectObjectContent (Maybe ScanRange) Source #

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

ScanRangemay be used in the following ways:

<scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)
<scanrange><start>50</start></scanrange> - process only the records starting after the byte 50
<scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

selectObjectContent_bucket :: Lens' SelectObjectContent BucketName Source #

The S3 bucket.

selectObjectContent_key :: Lens' SelectObjectContent ObjectKey Source #

The object key.

selectObjectContent_expression :: Lens' SelectObjectContent Text Source #

The expression that is used to query the object.

selectObjectContent_expressionType :: Lens' SelectObjectContent ExpressionType Source #

The type of the provided expression (for example, SQL).

selectObjectContent_inputSerialization :: Lens' SelectObjectContent InputSerialization Source #

Describes the format of the data in the object that is being queried.

selectObjectContent_outputSerialization :: Lens' SelectObjectContent OutputSerialization Source #

Describes the format of the data that you want Amazon S3 to return in response.

selectObjectContentResponse_payload :: Lens' SelectObjectContentResponse (Maybe SelectObjectContentEventStream) Source #

The array of results.

selectObjectContentResponse_httpStatus :: Lens' SelectObjectContentResponse Int Source #

The response's http status code.

UploadPart

uploadPart_checksumAlgorithm :: Lens' UploadPart (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

uploadPart_checksumCRC32 :: Lens' UploadPart (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

uploadPart_checksumCRC32C :: Lens' UploadPart (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

uploadPart_checksumSHA1 :: Lens' UploadPart (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

uploadPart_checksumSHA256 :: Lens' UploadPart (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

uploadPart_contentLength :: Lens' UploadPart (Maybe Integer) Source #

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

uploadPart_contentMD5 :: Lens' UploadPart (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

uploadPart_expectedBucketOwner :: Lens' UploadPart (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

uploadPart_requestPayer :: Lens' UploadPart (Maybe RequestPayer) Source #

Undocumented member.

uploadPart_sSECustomerAlgorithm :: Lens' UploadPart (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

uploadPart_sSECustomerKey :: Lens' UploadPart (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

uploadPart_sSECustomerKeyMD5 :: Lens' UploadPart (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

uploadPart_bucket :: Lens' UploadPart BucketName Source #

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

uploadPart_key :: Lens' UploadPart ObjectKey Source #

Object key for which the multipart upload was initiated.

uploadPart_partNumber :: Lens' UploadPart Int Source #

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

uploadPart_uploadId :: Lens' UploadPart Text Source #

Upload ID identifying the multipart upload whose part is being uploaded.

uploadPart_body :: Lens' UploadPart RequestBody Source #

Object data.

uploadPartResponse_bucketKeyEnabled :: Lens' UploadPartResponse (Maybe Bool) Source #

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

uploadPartResponse_checksumCRC32 :: Lens' UploadPartResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

uploadPartResponse_checksumCRC32C :: Lens' UploadPartResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

uploadPartResponse_checksumSHA1 :: Lens' UploadPartResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

uploadPartResponse_checksumSHA256 :: Lens' UploadPartResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

uploadPartResponse_eTag :: Lens' UploadPartResponse (Maybe ETag) Source #

Entity tag for the uploaded object.

uploadPartResponse_requestCharged :: Lens' UploadPartResponse (Maybe RequestCharged) Source #

Undocumented member.

uploadPartResponse_sSECustomerAlgorithm :: Lens' UploadPartResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

uploadPartResponse_sSECustomerKeyMD5 :: Lens' UploadPartResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

uploadPartResponse_sSEKMSKeyId :: Lens' UploadPartResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key was used for the object.

uploadPartResponse_serverSideEncryption :: Lens' UploadPartResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

uploadPartResponse_httpStatus :: Lens' UploadPartResponse Int Source #

The response's http status code.

UploadPartCopy

uploadPartCopy_copySourceIfMatch :: Lens' UploadPartCopy (Maybe Text) Source #

Copies the object if its entity tag (ETag) matches the specified tag.

uploadPartCopy_copySourceIfModifiedSince :: Lens' UploadPartCopy (Maybe UTCTime) Source #

Copies the object if it has been modified since the specified time.

uploadPartCopy_copySourceIfNoneMatch :: Lens' UploadPartCopy (Maybe Text) Source #

Copies the object if its entity tag (ETag) is different than the specified ETag.

uploadPartCopy_copySourceIfUnmodifiedSince :: Lens' UploadPartCopy (Maybe UTCTime) Source #

Copies the object if it hasn't been modified since the specified time.

uploadPartCopy_copySourceRange :: Lens' UploadPartCopy (Maybe Text) Source #

The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

uploadPartCopy_copySourceSSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the algorithm to use when decrypting the source object (for example, AES256).

uploadPartCopy_copySourceSSECustomerKey :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

uploadPartCopy_copySourceSSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

uploadPartCopy_expectedBucketOwner :: Lens' UploadPartCopy (Maybe Text) Source #

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

uploadPartCopy_expectedSourceBucketOwner :: Lens' UploadPartCopy (Maybe Text) Source #

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

uploadPartCopy_requestPayer :: Lens' UploadPartCopy (Maybe RequestPayer) Source #

Undocumented member.

uploadPartCopy_sSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

uploadPartCopy_sSECustomerKey :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

uploadPartCopy_sSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

uploadPartCopy_bucket :: Lens' UploadPartCopy BucketName Source #

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

uploadPartCopy_copySource :: Lens' UploadPartCopy Text Source #

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

uploadPartCopy_key :: Lens' UploadPartCopy ObjectKey Source #

Object key for which the multipart upload was initiated.

uploadPartCopy_partNumber :: Lens' UploadPartCopy Int Source #

Part number of part being copied. This is a positive integer between 1 and 10,000.

uploadPartCopy_uploadId :: Lens' UploadPartCopy Text Source #

Upload ID identifying the multipart upload whose part is being copied.

uploadPartCopyResponse_bucketKeyEnabled :: Lens' UploadPartCopyResponse (Maybe Bool) Source #

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

uploadPartCopyResponse_copyPartResult :: Lens' UploadPartCopyResponse (Maybe CopyPartResult) Source #

Container for all response elements.

uploadPartCopyResponse_copySourceVersionId :: Lens' UploadPartCopyResponse (Maybe Text) Source #

The version of the source object that was copied, if you have enabled versioning on the source bucket.

uploadPartCopyResponse_requestCharged :: Lens' UploadPartCopyResponse (Maybe RequestCharged) Source #

Undocumented member.

uploadPartCopyResponse_sSECustomerAlgorithm :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

uploadPartCopyResponse_sSECustomerKeyMD5 :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

uploadPartCopyResponse_sSEKMSKeyId :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

uploadPartCopyResponse_serverSideEncryption :: Lens' UploadPartCopyResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

uploadPartCopyResponse_httpStatus :: Lens' UploadPartCopyResponse Int Source #

The response's http status code.

WriteGetObjectResponse

writeGetObjectResponse_acceptRanges :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Indicates that a range of bytes was specified.

writeGetObjectResponse_bucketKeyEnabled :: Lens' WriteGetObjectResponse (Maybe Bool) Source #

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

writeGetObjectResponse_cacheControl :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

writeGetObjectResponse_checksumCRC32 :: Lens' WriteGetObjectResponse (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

writeGetObjectResponse_checksumCRC32C :: Lens' WriteGetObjectResponse (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

writeGetObjectResponse_checksumSHA1 :: Lens' WriteGetObjectResponse (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

writeGetObjectResponse_checksumSHA256 :: Lens' WriteGetObjectResponse (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

writeGetObjectResponse_contentDisposition :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Specifies presentational information for the object.

writeGetObjectResponse_contentEncoding :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

writeGetObjectResponse_contentLanguage :: Lens' WriteGetObjectResponse (Maybe Text) Source #

The language the content is in.

writeGetObjectResponse_contentLength :: Lens' WriteGetObjectResponse (Maybe Integer) Source #

The size of the content body in bytes.

writeGetObjectResponse_contentRange :: Lens' WriteGetObjectResponse (Maybe Text) Source #

The portion of the object returned in the response.

writeGetObjectResponse_contentType :: Lens' WriteGetObjectResponse (Maybe Text) Source #

A standard MIME type describing the format of the object data.

writeGetObjectResponse_deleteMarker :: Lens' WriteGetObjectResponse (Maybe Bool) Source #

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

writeGetObjectResponse_eTag :: Lens' WriteGetObjectResponse (Maybe ETag) Source #

An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

writeGetObjectResponse_errorCode :: Lens' WriteGetObjectResponse (Maybe Text) Source #

A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".

writeGetObjectResponse_errorMessage :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

writeGetObjectResponse_expiration :: Lens' WriteGetObjectResponse (Maybe Text) Source #

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.

writeGetObjectResponse_expires :: Lens' WriteGetObjectResponse (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable.

writeGetObjectResponse_lastModified :: Lens' WriteGetObjectResponse (Maybe UTCTime) Source #

The date and time that the object was last modified.

writeGetObjectResponse_metadata :: Lens' WriteGetObjectResponse (HashMap Text Text) Source #

A map of metadata to store with the object in S3.

writeGetObjectResponse_missingMeta :: Lens' WriteGetObjectResponse (Maybe Int) Source #

Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

writeGetObjectResponse_objectLockLegalHoldStatus :: Lens' WriteGetObjectResponse (Maybe ObjectLockLegalHoldStatus) Source #

Indicates whether an object stored in Amazon S3 has an active legal hold.

writeGetObjectResponse_objectLockMode :: Lens' WriteGetObjectResponse (Maybe ObjectLockMode) Source #

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

writeGetObjectResponse_objectLockRetainUntilDate :: Lens' WriteGetObjectResponse (Maybe UTCTime) Source #

The date and time when Object Lock is configured to expire.

writeGetObjectResponse_partsCount :: Lens' WriteGetObjectResponse (Maybe Int) Source #

The count of parts this object has.

writeGetObjectResponse_replicationStatus :: Lens' WriteGetObjectResponse (Maybe ReplicationStatus) Source #

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

writeGetObjectResponse_requestCharged :: Lens' WriteGetObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

writeGetObjectResponse_restore :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Provides information about object restoration operation and expiration time of the restored object copy.

writeGetObjectResponse_sSECustomerAlgorithm :: Lens' WriteGetObjectResponse (Maybe Text) Source #

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

writeGetObjectResponse_sSECustomerKeyMD5 :: Lens' WriteGetObjectResponse (Maybe Text) Source #

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

writeGetObjectResponse_sSEKMSKeyId :: Lens' WriteGetObjectResponse (Maybe Text) Source #

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for stored in Amazon S3 object.

writeGetObjectResponse_serverSideEncryption :: Lens' WriteGetObjectResponse (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

writeGetObjectResponse_statusCode :: Lens' WriteGetObjectResponse (Maybe Int) Source #

The integer status code for an HTTP response of a corresponding GetObject request.

Status Codes

```
200 - OK
```
```
206 - Partial Content
```
```
304 - Not Modified
```
```
400 - Bad Request
```
```
401 - Unauthorized
```
```
403 - Forbidden
```
```
404 - Not Found
```
```
405 - Method Not Allowed
```
```
409 - Conflict
```
```
411 - Length Required
```
```
412 - Precondition Failed
```
```
416 - Range Not Satisfiable
```
```
500 - Internal Server Error
```
```
503 - Service Unavailable
```

writeGetObjectResponse_storageClass :: Lens' WriteGetObjectResponse (Maybe StorageClass) Source #

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

writeGetObjectResponse_tagCount :: Lens' WriteGetObjectResponse (Maybe Int) Source #

The number of tags, if any, on the object.

writeGetObjectResponse_versionId :: Lens' WriteGetObjectResponse (Maybe ObjectVersionId) Source #

An ID used to reference a specific version of the object.

writeGetObjectResponse_requestRoute :: Lens' WriteGetObjectResponse Text Source #

Route prefix to the HTTP URL generated.

writeGetObjectResponse_requestToken :: Lens' WriteGetObjectResponse Text Source #

A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

writeGetObjectResponse_body :: Lens' WriteGetObjectResponse RequestBody Source #

The object data.

Types

AbortIncompleteMultipartUpload

abortIncompleteMultipartUpload_daysAfterInitiation :: Lens' AbortIncompleteMultipartUpload (Maybe Int) Source #

Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

AccelerateConfiguration

accelerateConfiguration_status :: Lens' AccelerateConfiguration (Maybe BucketAccelerateStatus) Source #

Specifies the transfer acceleration status of the bucket.

AccessControlPolicy

accessControlPolicy_grants :: Lens' AccessControlPolicy (Maybe [Grant]) Source #

A list of grants.

accessControlPolicy_owner :: Lens' AccessControlPolicy (Maybe Owner) Source #

Container for the bucket owner's display name and ID.

AccessControlTranslation

accessControlTranslation_owner :: Lens' AccessControlTranslation OwnerOverride Source #

Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.

AnalyticsAndOperator

analyticsAndOperator_prefix :: Lens' AnalyticsAndOperator (Maybe Text) Source #

The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

analyticsAndOperator_tags :: Lens' AnalyticsAndOperator (Maybe [Tag]) Source #

The list of tags to use when evaluating an AND predicate.

AnalyticsConfiguration

analyticsConfiguration_filter :: Lens' AnalyticsConfiguration (Maybe AnalyticsFilter) Source #

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

analyticsConfiguration_id :: Lens' AnalyticsConfiguration Text Source #

The ID that identifies the analytics configuration.

analyticsConfiguration_storageClassAnalysis :: Lens' AnalyticsConfiguration StorageClassAnalysis Source #

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

AnalyticsExportDestination

analyticsExportDestination_s3BucketDestination :: Lens' AnalyticsExportDestination AnalyticsS3BucketDestination Source #

A destination signifying output to an S3 bucket.

AnalyticsFilter

analyticsFilter_and :: Lens' AnalyticsFilter (Maybe AnalyticsAndOperator) Source #

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

analyticsFilter_prefix :: Lens' AnalyticsFilter (Maybe Text) Source #

The prefix to use when evaluating an analytics filter.

analyticsFilter_tag :: Lens' AnalyticsFilter (Maybe Tag) Source #

The tag to use when evaluating an analytics filter.

AnalyticsS3BucketDestination

analyticsS3BucketDestination_bucketAccountId :: Lens' AnalyticsS3BucketDestination (Maybe Text) Source #

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

analyticsS3BucketDestination_prefix :: Lens' AnalyticsS3BucketDestination (Maybe Text) Source #

The prefix to use when exporting data. The prefix is prepended to all results.

analyticsS3BucketDestination_format :: Lens' AnalyticsS3BucketDestination AnalyticsS3ExportFileFormat Source #

Specifies the file format used when exporting data to Amazon S3.

analyticsS3BucketDestination_bucket :: Lens' AnalyticsS3BucketDestination BucketName Source #

The Amazon Resource Name (ARN) of the bucket to which data is exported.

Bucket

bucket_creationDate :: Lens' Bucket UTCTime Source #

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

bucket_name :: Lens' Bucket BucketName Source #

The name of the bucket.

BucketLifecycleConfiguration

bucketLifecycleConfiguration_rules :: Lens' BucketLifecycleConfiguration [LifecycleRule] Source #

A lifecycle rule for individual objects in an Amazon S3 bucket.

BucketLoggingStatus

bucketLoggingStatus_loggingEnabled :: Lens' BucketLoggingStatus (Maybe LoggingEnabled) Source #

Undocumented member.

CORSConfiguration

cORSConfiguration_cORSRules :: Lens' CORSConfiguration [CORSRule] Source #

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

CORSRule

cORSRule_allowedHeaders :: Lens' CORSRule (Maybe [Text]) Source #

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

cORSRule_exposeHeaders :: Lens' CORSRule (Maybe [Text]) Source #

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

cORSRule_id :: Lens' CORSRule (Maybe Text) Source #

Unique identifier for the rule. The value cannot be longer than 255 characters.

cORSRule_maxAgeSeconds :: Lens' CORSRule (Maybe Int) Source #

The time in seconds that your browser is to cache the preflight response for the specified resource.

cORSRule_allowedMethods :: Lens' CORSRule [Text] Source #

An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

cORSRule_allowedOrigins :: Lens' CORSRule [Text] Source #

One or more origins you want customers to be able to access the bucket from.

CSVInput

cSVInput_allowQuotedRecordDelimiter :: Lens' CSVInput (Maybe Bool) Source #

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

cSVInput_comments :: Lens' CSVInput (Maybe Text) Source #

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.

cSVInput_fieldDelimiter :: Lens' CSVInput (Maybe Text) Source #

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

cSVInput_fileHeaderInfo :: Lens' CSVInput (Maybe FileHeaderInfo) Source #

Describes the first line of input. Valid values are:

NONE: First line is not a header.
IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).
Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

cSVInput_quoteCharacter :: Lens' CSVInput (Maybe Text) Source #

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

cSVInput_quoteEscapeCharacter :: Lens' CSVInput (Maybe Text) Source #

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

cSVInput_recordDelimiter :: Lens' CSVInput (Maybe Text) Source #

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

CSVOutput

cSVOutput_fieldDelimiter :: Lens' CSVOutput (Maybe Text) Source #

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

cSVOutput_quoteCharacter :: Lens' CSVOutput (Maybe Text) Source #

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

cSVOutput_quoteEscapeCharacter :: Lens' CSVOutput (Maybe Text) Source #

The single character used for escaping the quote character inside an already escaped value.

cSVOutput_quoteFields :: Lens' CSVOutput (Maybe QuoteFields) Source #

Indicates whether to use quotation marks around output fields.

ALWAYS: Always use quotation marks for output fields.
ASNEEDED: Use quotation marks for output fields when needed.

cSVOutput_recordDelimiter :: Lens' CSVOutput (Maybe Text) Source #

A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

Checksum

checksum_checksumCRC32 :: Lens' Checksum (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksum_checksumCRC32C :: Lens' Checksum (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksum_checksumSHA1 :: Lens' Checksum (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksum_checksumSHA256 :: Lens' Checksum (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

CommonPrefix

commonPrefix_prefix :: Lens' CommonPrefix (Maybe Text) Source #

Container for the specified common prefix.

CompletedMultipartUpload

completedMultipartUpload_parts :: Lens' CompletedMultipartUpload (Maybe (NonEmpty CompletedPart)) Source #

Array of CompletedPart data types.

If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.

CompletedPart

completedPart_checksumCRC32 :: Lens' CompletedPart (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completedPart_checksumCRC32C :: Lens' CompletedPart (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completedPart_checksumSHA1 :: Lens' CompletedPart (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completedPart_checksumSHA256 :: Lens' CompletedPart (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

completedPart_partNumber :: Lens' CompletedPart Int Source #

Part number that identifies the part. This is a positive integer between 1 and 10,000.

completedPart_eTag :: Lens' CompletedPart ETag Source #

Entity tag returned when the part was uploaded.

Condition

condition_httpErrorCodeReturnedEquals :: Lens' Condition (Maybe Text) Source #

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

condition_keyPrefixEquals :: Lens' Condition (Maybe Text) Source #

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

ContinuationEvent

CopyObjectResult

copyObjectResult_checksumCRC32 :: Lens' CopyObjectResult (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyObjectResult_checksumCRC32C :: Lens' CopyObjectResult (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyObjectResult_checksumSHA1 :: Lens' CopyObjectResult (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyObjectResult_checksumSHA256 :: Lens' CopyObjectResult (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyObjectResult_eTag :: Lens' CopyObjectResult (Maybe ETag) Source #

Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

copyObjectResult_lastModified :: Lens' CopyObjectResult (Maybe UTCTime) Source #

Creation date of the object.

CopyPartResult

copyPartResult_checksumCRC32 :: Lens' CopyPartResult (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyPartResult_checksumCRC32C :: Lens' CopyPartResult (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyPartResult_checksumSHA1 :: Lens' CopyPartResult (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyPartResult_checksumSHA256 :: Lens' CopyPartResult (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

copyPartResult_eTag :: Lens' CopyPartResult (Maybe ETag) Source #

Entity tag of the object.

copyPartResult_lastModified :: Lens' CopyPartResult (Maybe UTCTime) Source #

Date and time at which the object was uploaded.

CreateBucketConfiguration

createBucketConfiguration_locationConstraint :: Lens' CreateBucketConfiguration (Maybe LocationConstraint) Source #

Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).

DefaultRetention

defaultRetention_days :: Lens' DefaultRetention (Maybe Int) Source #

The number of days that you want to specify for the default retention period. Must be used with Mode.

defaultRetention_mode :: Lens' DefaultRetention (Maybe ObjectLockRetentionMode) Source #

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

defaultRetention_years :: Lens' DefaultRetention (Maybe Int) Source #

The number of years that you want to specify for the default retention period. Must be used with Mode.

Delete

delete_quiet :: Lens' Delete (Maybe Bool) Source #

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

delete_objects :: Lens' Delete [ObjectIdentifier] Source #

The objects to delete.

DeleteMarkerEntry

deleteMarkerEntry_isLatest :: Lens' DeleteMarkerEntry (Maybe Bool) Source #

Specifies whether the object is (true) or is not (false) the latest version of an object.

deleteMarkerEntry_key :: Lens' DeleteMarkerEntry (Maybe ObjectKey) Source #

The object key.

deleteMarkerEntry_lastModified :: Lens' DeleteMarkerEntry (Maybe UTCTime) Source #

Date and time the object was last modified.

deleteMarkerEntry_owner :: Lens' DeleteMarkerEntry (Maybe Owner) Source #

The account that created the delete marker.>

deleteMarkerEntry_versionId :: Lens' DeleteMarkerEntry (Maybe ObjectVersionId) Source #

Version ID of an object.

DeleteMarkerReplication

deleteMarkerReplication_status :: Lens' DeleteMarkerReplication (Maybe DeleteMarkerReplicationStatus) Source #

Indicates whether to replicate delete markers.

DeletedObject

deletedObject_deleteMarker :: Lens' DeletedObject (Maybe Bool) Source #

Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.

deletedObject_deleteMarkerVersionId :: Lens' DeletedObject (Maybe Text) Source #

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

deletedObject_key :: Lens' DeletedObject (Maybe ObjectKey) Source #

The name of the deleted object.

deletedObject_versionId :: Lens' DeletedObject (Maybe ObjectVersionId) Source #

The version ID of the deleted object.

Destination

destination_accessControlTranslation :: Lens' Destination (Maybe AccessControlTranslation) Source #

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

destination_account :: Lens' Destination (Maybe Text) Source #

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon S3 User Guide.

destination_encryptionConfiguration :: Lens' Destination (Maybe EncryptionConfiguration) Source #

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

destination_metrics :: Lens' Destination (Maybe Metrics) Source #

A container specifying replication metrics-related settings enabling replication metrics and events.

destination_replicationTime :: Lens' Destination (Maybe ReplicationTime) Source #

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.

destination_storageClass :: Lens' Destination (Maybe StorageClass) Source #

The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.

destination_bucket :: Lens' Destination BucketName Source #

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

Encryption

encryption_kmsContext :: Lens' Encryption (Maybe Text) Source #

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

encryption_kmsKeyId :: Lens' Encryption (Maybe Text) Source #

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

encryption_encryptionType :: Lens' Encryption ServerSideEncryption Source #

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

EncryptionConfiguration

encryptionConfiguration_replicaKmsKeyID :: Lens' EncryptionConfiguration (Maybe Text) Source #

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

EndEvent

ErrorDocument

errorDocument_key :: Lens' ErrorDocument ObjectKey Source #

The object key name to use when a 4XX class error occurs.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

EventBridgeConfiguration

ExistingObjectReplication

existingObjectReplication_status :: Lens' ExistingObjectReplication ExistingObjectReplicationStatus Source #

FilterRule

filterRule_name :: Lens' FilterRule (Maybe FilterRuleName) Source #

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

filterRule_value :: Lens' FilterRule (Maybe Text) Source #

The value that the filter searches for in object key names.

GetObjectAttributesParts

getObjectAttributesParts_isTruncated :: Lens' GetObjectAttributesParts (Maybe Bool) Source #

Indicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

getObjectAttributesParts_maxParts :: Lens' GetObjectAttributesParts (Maybe Int) Source #

The maximum number of parts allowed in the response.

getObjectAttributesParts_nextPartNumberMarker :: Lens' GetObjectAttributesParts (Maybe Int) Source #

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.

getObjectAttributesParts_partNumberMarker :: Lens' GetObjectAttributesParts (Maybe Int) Source #

The marker for the current part.

getObjectAttributesParts_parts :: Lens' GetObjectAttributesParts (Maybe [ObjectPart]) Source #

A container for elements related to a particular part. A response can contain zero or more Parts elements.

getObjectAttributesParts_totalPartsCount :: Lens' GetObjectAttributesParts (Maybe Int) Source #

The total number of parts.

GlacierJobParameters

glacierJobParameters_tier :: Lens' GlacierJobParameters Tier Source #

Retrieval tier at which the restore will be processed.

Grant

grant_grantee :: Lens' Grant (Maybe Grantee) Source #

The person being granted permissions.

grant_permission :: Lens' Grant (Maybe Permission) Source #

Specifies the permission given to the grantee.

Grantee

grantee_displayName :: Lens' Grantee (Maybe Text) Source #

Screen name of the grantee.

grantee_emailAddress :: Lens' Grantee (Maybe Text) Source #

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

grantee_id :: Lens' Grantee (Maybe Text) Source #

The canonical user ID of the grantee.

grantee_uri :: Lens' Grantee (Maybe Text) Source #

URI of the grantee group.

grantee_type :: Lens' Grantee Type Source #

Type of grantee

IndexDocument

indexDocument_suffix :: Lens' IndexDocument Text Source #

A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Initiator

initiator_displayName :: Lens' Initiator (Maybe Text) Source #

Name of the Principal.

initiator_id :: Lens' Initiator (Maybe Text) Source #

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

InputSerialization

inputSerialization_csv :: Lens' InputSerialization (Maybe CSVInput) Source #

Describes the serialization of a CSV-encoded object.

inputSerialization_compressionType :: Lens' InputSerialization (Maybe CompressionType) Source #

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

inputSerialization_json :: Lens' InputSerialization (Maybe JSONInput) Source #

Specifies JSON as object's input serialization format.

inputSerialization_parquet :: Lens' InputSerialization (Maybe ParquetInput) Source #

Specifies Parquet as object's input serialization format.

IntelligentTieringAndOperator

intelligentTieringAndOperator_prefix :: Lens' IntelligentTieringAndOperator (Maybe Text) Source #

An object key name prefix that identifies the subset of objects to which the configuration applies.

intelligentTieringAndOperator_tags :: Lens' IntelligentTieringAndOperator (Maybe [Tag]) Source #

All of these tags must exist in the object's tag set in order for the configuration to apply.

IntelligentTieringConfiguration

intelligentTieringConfiguration_filter :: Lens' IntelligentTieringConfiguration (Maybe IntelligentTieringFilter) Source #

Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.

intelligentTieringConfiguration_id :: Lens' IntelligentTieringConfiguration Text Source #

The ID used to identify the S3 Intelligent-Tiering configuration.

intelligentTieringConfiguration_status :: Lens' IntelligentTieringConfiguration IntelligentTieringStatus Source #

Specifies the status of the configuration.

intelligentTieringConfiguration_tierings :: Lens' IntelligentTieringConfiguration [Tiering] Source #

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

IntelligentTieringFilter

intelligentTieringFilter_and :: Lens' IntelligentTieringFilter (Maybe IntelligentTieringAndOperator) Source #

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

intelligentTieringFilter_prefix :: Lens' IntelligentTieringFilter (Maybe Text) Source #

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

intelligentTieringFilter_tag :: Lens' IntelligentTieringFilter (Maybe Tag) Source #

Undocumented member.

InventoryConfiguration

inventoryConfiguration_filter :: Lens' InventoryConfiguration (Maybe InventoryFilter) Source #

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

inventoryConfiguration_optionalFields :: Lens' InventoryConfiguration (Maybe [InventoryOptionalField]) Source #

Contains the optional fields that are included in the inventory results.

inventoryConfiguration_destination :: Lens' InventoryConfiguration InventoryDestination Source #

Contains information about where to publish the inventory results.

inventoryConfiguration_isEnabled :: Lens' InventoryConfiguration Bool Source #

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

inventoryConfiguration_id :: Lens' InventoryConfiguration Text Source #

The ID used to identify the inventory configuration.

inventoryConfiguration_includedObjectVersions :: Lens' InventoryConfiguration InventoryIncludedObjectVersions Source #

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

inventoryConfiguration_schedule :: Lens' InventoryConfiguration InventorySchedule Source #

Specifies the schedule for generating inventory results.

InventoryDestination

inventoryDestination_s3BucketDestination :: Lens' InventoryDestination InventoryS3BucketDestination Source #

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

InventoryEncryption

inventoryEncryption_ssekms :: Lens' InventoryEncryption (Maybe SSEKMS) Source #

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

inventoryEncryption_sses3 :: Lens' InventoryEncryption (Maybe SSES3) Source #

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

InventoryFilter

inventoryFilter_prefix :: Lens' InventoryFilter Text Source #

The prefix that an object must have to be included in the inventory results.

InventoryS3BucketDestination

inventoryS3BucketDestination_accountId :: Lens' InventoryS3BucketDestination (Maybe Text) Source #

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

inventoryS3BucketDestination_encryption :: Lens' InventoryS3BucketDestination (Maybe InventoryEncryption) Source #

Contains the type of server-side encryption used to encrypt the inventory results.

inventoryS3BucketDestination_prefix :: Lens' InventoryS3BucketDestination (Maybe Text) Source #

The prefix that is prepended to all inventory results.

inventoryS3BucketDestination_bucket :: Lens' InventoryS3BucketDestination BucketName Source #

The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

inventoryS3BucketDestination_format :: Lens' InventoryS3BucketDestination InventoryFormat Source #

Specifies the output format of the inventory results.

InventorySchedule

inventorySchedule_frequency :: Lens' InventorySchedule InventoryFrequency Source #

Specifies how frequently inventory results are produced.

JSONInput

jSONInput_type :: Lens' JSONInput (Maybe JSONType) Source #

The type of JSON. Valid values: Document, Lines.

JSONOutput

jSONOutput_recordDelimiter :: Lens' JSONOutput (Maybe Text) Source #

The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character ('\n').

LambdaFunctionConfiguration

lambdaFunctionConfiguration_filter :: Lens' LambdaFunctionConfiguration (Maybe NotificationConfigurationFilter) Source #

Undocumented member.

lambdaFunctionConfiguration_id :: Lens' LambdaFunctionConfiguration (Maybe Text) Source #

Undocumented member.

lambdaFunctionConfiguration_lambdaFunctionArn :: Lens' LambdaFunctionConfiguration Text Source #

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

lambdaFunctionConfiguration_events :: Lens' LambdaFunctionConfiguration [Event] Source #

The Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.

LifecycleExpiration

lifecycleExpiration_date :: Lens' LifecycleExpiration (Maybe UTCTime) Source #

Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

lifecycleExpiration_days :: Lens' LifecycleExpiration (Maybe Int) Source #

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

lifecycleExpiration_expiredObjectDeleteMarker :: Lens' LifecycleExpiration (Maybe Bool) Source #

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

LifecycleRule

lifecycleRule_abortIncompleteMultipartUpload :: Lens' LifecycleRule (Maybe AbortIncompleteMultipartUpload) Source #

Undocumented member.

lifecycleRule_expiration :: Lens' LifecycleRule (Maybe LifecycleExpiration) Source #

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

lifecycleRule_filter :: Lens' LifecycleRule (Maybe LifecycleRuleFilter) Source #

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

lifecycleRule_id :: Lens' LifecycleRule (Maybe Text) Source #

Unique identifier for the rule. The value cannot be longer than 255 characters.

lifecycleRule_noncurrentVersionExpiration :: Lens' LifecycleRule (Maybe NoncurrentVersionExpiration) Source #

Undocumented member.

lifecycleRule_noncurrentVersionTransitions :: Lens' LifecycleRule (Maybe [NoncurrentVersionTransition]) Source #

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

lifecycleRule_prefix :: Lens' LifecycleRule (Maybe Text) Source #

Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

lifecycleRule_transitions :: Lens' LifecycleRule (Maybe [Transition]) Source #

Specifies when an Amazon S3 object transitions to a specified storage class.

lifecycleRule_status :: Lens' LifecycleRule ExpirationStatus Source #

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

LifecycleRuleAndOperator

lifecycleRuleAndOperator_objectSizeGreaterThan :: Lens' LifecycleRuleAndOperator (Maybe Integer) Source #

Minimum object size to which the rule applies.

lifecycleRuleAndOperator_objectSizeLessThan :: Lens' LifecycleRuleAndOperator (Maybe Integer) Source #

Maximum object size to which the rule applies.

lifecycleRuleAndOperator_prefix :: Lens' LifecycleRuleAndOperator (Maybe Text) Source #

Prefix identifying one or more objects to which the rule applies.

lifecycleRuleAndOperator_tags :: Lens' LifecycleRuleAndOperator (Maybe [Tag]) Source #

All of these tags must exist in the object's tag set in order for the rule to apply.

LifecycleRuleFilter

lifecycleRuleFilter_and :: Lens' LifecycleRuleFilter (Maybe LifecycleRuleAndOperator) Source #

Undocumented member.

lifecycleRuleFilter_objectSizeGreaterThan :: Lens' LifecycleRuleFilter (Maybe Integer) Source #

Minimum object size to which the rule applies.

lifecycleRuleFilter_objectSizeLessThan :: Lens' LifecycleRuleFilter (Maybe Integer) Source #

Maximum object size to which the rule applies.

lifecycleRuleFilter_prefix :: Lens' LifecycleRuleFilter (Maybe Text) Source #

Prefix identifying one or more objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

lifecycleRuleFilter_tag :: Lens' LifecycleRuleFilter (Maybe Tag) Source #

This tag must exist in the object's tag set in order for the rule to apply.

LoggingEnabled

loggingEnabled_targetGrants :: Lens' LoggingEnabled (Maybe [TargetGrant]) Source #

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

loggingEnabled_targetBucket :: Lens' LoggingEnabled Text Source #

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

loggingEnabled_targetPrefix :: Lens' LoggingEnabled Text Source #

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

MetadataEntry

metadataEntry_name :: Lens' MetadataEntry (Maybe Text) Source #

Name of the Object.

metadataEntry_value :: Lens' MetadataEntry (Maybe Text) Source #

Value of the Object.

Metrics

metrics_eventThreshold :: Lens' Metrics (Maybe ReplicationTimeValue) Source #

A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.

metrics_status :: Lens' Metrics MetricsStatus Source #

Specifies whether the replication metrics are enabled.

MetricsAndOperator

metricsAndOperator_accessPointArn :: Lens' MetricsAndOperator (Maybe Text) Source #

The access point ARN used when evaluating an AND predicate.

metricsAndOperator_prefix :: Lens' MetricsAndOperator (Maybe Text) Source #

The prefix used when evaluating an AND predicate.

metricsAndOperator_tags :: Lens' MetricsAndOperator (Maybe [Tag]) Source #

The list of tags used when evaluating an AND predicate.

MetricsConfiguration

metricsConfiguration_filter :: Lens' MetricsConfiguration (Maybe MetricsFilter) Source #

Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

metricsConfiguration_id :: Lens' MetricsConfiguration Text Source #

The ID used to identify the metrics configuration.

MetricsFilter

metricsFilter_accessPointArn :: Lens' MetricsFilter (Maybe Text) Source #

The access point ARN used when evaluating a metrics filter.

metricsFilter_and :: Lens' MetricsFilter (Maybe MetricsAndOperator) Source #

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

metricsFilter_prefix :: Lens' MetricsFilter (Maybe Text) Source #

The prefix used when evaluating a metrics filter.

metricsFilter_tag :: Lens' MetricsFilter (Maybe Tag) Source #

The tag used when evaluating a metrics filter.

MultipartUpload

multipartUpload_checksumAlgorithm :: Lens' MultipartUpload (Maybe ChecksumAlgorithm) Source #

The algorithm that was used to create a checksum of the object.

multipartUpload_initiated :: Lens' MultipartUpload (Maybe UTCTime) Source #

Date and time at which the multipart upload was initiated.

multipartUpload_initiator :: Lens' MultipartUpload (Maybe Initiator) Source #

Identifies who initiated the multipart upload.

multipartUpload_key :: Lens' MultipartUpload (Maybe ObjectKey) Source #

Key of the object for which the multipart upload was initiated.

multipartUpload_owner :: Lens' MultipartUpload (Maybe Owner) Source #

Specifies the owner of the object that is part of the multipart upload.

multipartUpload_storageClass :: Lens' MultipartUpload (Maybe StorageClass) Source #

The class of storage used to store the object.

multipartUpload_uploadId :: Lens' MultipartUpload (Maybe Text) Source #

Upload ID that identifies the multipart upload.

NoncurrentVersionExpiration

noncurrentVersionExpiration_newerNoncurrentVersions :: Lens' NoncurrentVersionExpiration (Maybe Int) Source #

Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

noncurrentVersionExpiration_noncurrentDays :: Lens' NoncurrentVersionExpiration Int Source #

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

NoncurrentVersionTransition

noncurrentVersionTransition_newerNoncurrentVersions :: Lens' NoncurrentVersionTransition (Maybe Int) Source #

Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

noncurrentVersionTransition_noncurrentDays :: Lens' NoncurrentVersionTransition Int Source #

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

noncurrentVersionTransition_storageClass :: Lens' NoncurrentVersionTransition TransitionStorageClass Source #

The class of storage used to store the object.

NotificationConfiguration

notificationConfiguration_eventBridgeConfiguration :: Lens' NotificationConfiguration (Maybe EventBridgeConfiguration) Source #

Enables delivery of events to Amazon EventBridge.

notificationConfiguration_lambdaFunctionConfigurations :: Lens' NotificationConfiguration (Maybe [LambdaFunctionConfiguration]) Source #

Describes the Lambda functions to invoke and the events for which to invoke them.

notificationConfiguration_queueConfigurations :: Lens' NotificationConfiguration (Maybe [QueueConfiguration]) Source #

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

notificationConfiguration_topicConfigurations :: Lens' NotificationConfiguration (Maybe [TopicConfiguration]) Source #

The topic to which notifications are sent and the events for which notifications are generated.

NotificationConfigurationFilter

notificationConfigurationFilter_key :: Lens' NotificationConfigurationFilter (Maybe S3KeyFilter) Source #

Undocumented member.

Object

object_checksumAlgorithm :: Lens' Object (Maybe [ChecksumAlgorithm]) Source #

The algorithm that was used to create a checksum of the object.

object_owner :: Lens' Object (Maybe Owner) Source #

The owner of the object

object_eTag :: Lens' Object ETag Source #

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

object_size :: Lens' Object Integer Source #

Size in bytes of the object

object_key :: Lens' Object ObjectKey Source #

The name that you assign to an object. You use the object key to retrieve the object.

object_storageClass :: Lens' Object ObjectStorageClass Source #

The class of storage used to store the object.

object_lastModified :: Lens' Object UTCTime Source #

Creation date of the object.

ObjectIdentifier

objectIdentifier_versionId :: Lens' ObjectIdentifier (Maybe ObjectVersionId) Source #

VersionId for the specific version of the object to delete.

objectIdentifier_key :: Lens' ObjectIdentifier ObjectKey Source #

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

ObjectLockConfiguration

objectLockConfiguration_objectLockEnabled :: Lens' ObjectLockConfiguration (Maybe ObjectLockEnabled) Source #

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

objectLockConfiguration_rule :: Lens' ObjectLockConfiguration (Maybe ObjectLockRule) Source #

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

ObjectLockLegalHold

objectLockLegalHold_status :: Lens' ObjectLockLegalHold (Maybe ObjectLockLegalHoldStatus) Source #

Indicates whether the specified object has a legal hold in place.

ObjectLockRetention

objectLockRetention_mode :: Lens' ObjectLockRetention (Maybe ObjectLockRetentionMode) Source #

Indicates the Retention mode for the specified object.

objectLockRetention_retainUntilDate :: Lens' ObjectLockRetention (Maybe UTCTime) Source #

The date on which this Object Lock Retention will expire.

ObjectLockRule

objectLockRule_defaultRetention :: Lens' ObjectLockRule (Maybe DefaultRetention) Source #

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

ObjectPart

objectPart_checksumCRC32 :: Lens' ObjectPart (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

objectPart_checksumCRC32C :: Lens' ObjectPart (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

objectPart_checksumSHA1 :: Lens' ObjectPart (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

objectPart_checksumSHA256 :: Lens' ObjectPart (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

objectPart_partNumber :: Lens' ObjectPart (Maybe Int) Source #

The part number identifying the part. This value is a positive integer between 1 and 10,000.

objectPart_size :: Lens' ObjectPart (Maybe Integer) Source #

The size of the uploaded part in bytes.

ObjectVersion

objectVersion_checksumAlgorithm :: Lens' ObjectVersion (Maybe [ChecksumAlgorithm]) Source #

The algorithm that was used to create a checksum of the object.

objectVersion_eTag :: Lens' ObjectVersion (Maybe ETag) Source #

The entity tag is an MD5 hash of that version of the object.

objectVersion_isLatest :: Lens' ObjectVersion (Maybe Bool) Source #

Specifies whether the object is (true) or is not (false) the latest version of an object.

objectVersion_key :: Lens' ObjectVersion (Maybe ObjectKey) Source #

The object key.

objectVersion_lastModified :: Lens' ObjectVersion (Maybe UTCTime) Source #

Date and time the object was last modified.

objectVersion_owner :: Lens' ObjectVersion (Maybe Owner) Source #

Specifies the owner of the object.

objectVersion_size :: Lens' ObjectVersion (Maybe Integer) Source #

Size in bytes of the object.

objectVersion_storageClass :: Lens' ObjectVersion (Maybe ObjectVersionStorageClass) Source #

The class of storage used to store the object.

objectVersion_versionId :: Lens' ObjectVersion (Maybe ObjectVersionId) Source #

Version ID of an object.

OutputLocation

outputLocation_s3 :: Lens' OutputLocation (Maybe S3Location) Source #

Describes an S3 location that will receive the results of the restore request.

OutputSerialization

outputSerialization_csv :: Lens' OutputSerialization (Maybe CSVOutput) Source #

Describes the serialization of CSV-encoded Select results.

outputSerialization_json :: Lens' OutputSerialization (Maybe JSONOutput) Source #

Specifies JSON as request's output serialization format.

Owner

owner_displayName :: Lens' Owner (Maybe Text) Source #

Container for the display name of the owner.

owner_id :: Lens' Owner (Maybe Text) Source #

Container for the ID of the owner.

OwnershipControls

ownershipControls_rules :: Lens' OwnershipControls [OwnershipControlsRule] Source #

The container element for an ownership control rule.

OwnershipControlsRule

ownershipControlsRule_objectOwnership :: Lens' OwnershipControlsRule ObjectOwnership Source #

Undocumented member.

ParquetInput

Part

part_checksumCRC32 :: Lens' Part (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

part_checksumCRC32C :: Lens' Part (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

part_checksumSHA1 :: Lens' Part (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

part_checksumSHA256 :: Lens' Part (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

part_eTag :: Lens' Part (Maybe ETag) Source #

Entity tag returned when the part was uploaded.

part_lastModified :: Lens' Part (Maybe UTCTime) Source #

Date and time at which the part was uploaded.

part_partNumber :: Lens' Part (Maybe Int) Source #

Part number identifying the part. This is a positive integer between 1 and 10,000.

part_size :: Lens' Part (Maybe Integer) Source #

Size in bytes of the uploaded part data.

PolicyStatus

policyStatus_isPublic :: Lens' PolicyStatus (Maybe Bool) Source #

The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

Progress

progress_bytesProcessed :: Lens' Progress (Maybe Integer) Source #

The current number of uncompressed object bytes processed.

progress_bytesReturned :: Lens' Progress (Maybe Integer) Source #

The current number of bytes of records payload data returned.

progress_bytesScanned :: Lens' Progress (Maybe Integer) Source #

The current number of object bytes scanned.

ProgressEvent

progressEvent_details :: Lens' ProgressEvent (Maybe Progress) Source #

The Progress event details.

PublicAccessBlockConfiguration

publicAccessBlockConfiguration_blockPublicAcls :: Lens' PublicAccessBlockConfiguration (Maybe Bool) Source #

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.

Enabling this setting doesn't affect existing policies or ACLs.

publicAccessBlockConfiguration_blockPublicPolicy :: Lens' PublicAccessBlockConfiguration (Maybe Bool) Source #

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Enabling this setting doesn't affect existing bucket policies.

publicAccessBlockConfiguration_ignorePublicAcls :: Lens' PublicAccessBlockConfiguration (Maybe Bool) Source #

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

publicAccessBlockConfiguration_restrictPublicBuckets :: Lens' PublicAccessBlockConfiguration (Maybe Bool) Source #

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

QueueConfiguration

queueConfiguration_filter :: Lens' QueueConfiguration (Maybe NotificationConfigurationFilter) Source #

Undocumented member.

queueConfiguration_id :: Lens' QueueConfiguration (Maybe Text) Source #

Undocumented member.

queueConfiguration_queueArn :: Lens' QueueConfiguration Text Source #

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

queueConfiguration_events :: Lens' QueueConfiguration [Event] Source #

A collection of bucket events for which to send notifications

RecordsEvent

recordsEvent_payload :: Lens' RecordsEvent (Maybe ByteString) Source #

The byte array of partial, one or more result records.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Redirect

redirect_hostName :: Lens' Redirect (Maybe Text) Source #

The host name to use in the redirect request.

redirect_httpRedirectCode :: Lens' Redirect (Maybe Text) Source #

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

redirect_protocol :: Lens' Redirect (Maybe Protocol) Source #

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

redirect_replaceKeyPrefixWith :: Lens' Redirect (Maybe Text) Source #

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

redirect_replaceKeyWith :: Lens' Redirect (Maybe Text) Source #

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

RedirectAllRequestsTo

redirectAllRequestsTo_protocol :: Lens' RedirectAllRequestsTo (Maybe Protocol) Source #

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

redirectAllRequestsTo_hostName :: Lens' RedirectAllRequestsTo Text Source #

Name of the host where requests are redirected.

ReplicaModifications

replicaModifications_status :: Lens' ReplicaModifications ReplicaModificationsStatus Source #

Specifies whether Amazon S3 replicates modifications on replicas.

ReplicationConfiguration

replicationConfiguration_role :: Lens' ReplicationConfiguration Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.

replicationConfiguration_rules :: Lens' ReplicationConfiguration [ReplicationRule] Source #

A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

ReplicationRule

replicationRule_deleteMarkerReplication :: Lens' ReplicationRule (Maybe DeleteMarkerReplication) Source #

Undocumented member.

replicationRule_existingObjectReplication :: Lens' ReplicationRule (Maybe ExistingObjectReplication) Source #

replicationRule_filter :: Lens' ReplicationRule (Maybe ReplicationRuleFilter) Source #

Undocumented member.

replicationRule_id :: Lens' ReplicationRule (Maybe Text) Source #

A unique identifier for the rule. The maximum value is 255 characters.

replicationRule_prefix :: Lens' ReplicationRule (Maybe Text) Source #

An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

replicationRule_priority :: Lens' ReplicationRule (Maybe Int) Source #

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide.

replicationRule_sourceSelectionCriteria :: Lens' ReplicationRule (Maybe SourceSelectionCriteria) Source #

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

replicationRule_status :: Lens' ReplicationRule ReplicationRuleStatus Source #

Specifies whether the rule is enabled.

replicationRule_destination :: Lens' ReplicationRule Destination Source #

A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

ReplicationRuleAndOperator

replicationRuleAndOperator_prefix :: Lens' ReplicationRuleAndOperator (Maybe Text) Source #

An object key name prefix that identifies the subset of objects to which the rule applies.

replicationRuleAndOperator_tags :: Lens' ReplicationRuleAndOperator (Maybe [Tag]) Source #

An array of tags containing key and value pairs.

ReplicationRuleFilter

replicationRuleFilter_and :: Lens' ReplicationRuleFilter (Maybe ReplicationRuleAndOperator) Source #

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.

replicationRuleFilter_prefix :: Lens' ReplicationRuleFilter (Maybe Text) Source #

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

replicationRuleFilter_tag :: Lens' ReplicationRuleFilter (Maybe Tag) Source #

A container for specifying a tag key and value.

The rule applies only to objects that have the tag in their tag set.

ReplicationTime

replicationTime_status :: Lens' ReplicationTime ReplicationTimeStatus Source #

Specifies whether the replication time is enabled.

replicationTime_time :: Lens' ReplicationTime ReplicationTimeValue Source #

A container specifying the time by which replication should be complete for all objects and operations on objects.

ReplicationTimeValue

replicationTimeValue_minutes :: Lens' ReplicationTimeValue (Maybe Int) Source #

Contains an integer specifying time in minutes.

Valid value: 15

RequestPaymentConfiguration

requestPaymentConfiguration_payer :: Lens' RequestPaymentConfiguration Payer Source #

Specifies who pays for the download and request fees.

RequestProgress

requestProgress_enabled :: Lens' RequestProgress (Maybe Bool) Source #

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.

RestoreRequest

restoreRequest_days :: Lens' RestoreRequest (Maybe Int) Source #

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

restoreRequest_description :: Lens' RestoreRequest (Maybe Text) Source #

The optional description for the job.

restoreRequest_glacierJobParameters :: Lens' RestoreRequest (Maybe GlacierJobParameters) Source #

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

restoreRequest_outputLocation :: Lens' RestoreRequest (Maybe OutputLocation) Source #

Describes the location where the restore job's output is stored.

restoreRequest_selectParameters :: Lens' RestoreRequest (Maybe SelectParameters) Source #

Describes the parameters for Select job types.

restoreRequest_tier :: Lens' RestoreRequest (Maybe Tier) Source #

Retrieval tier at which the restore will be processed.

restoreRequest_type :: Lens' RestoreRequest (Maybe RestoreRequestType) Source #

Type of restore request.

RoutingRule

routingRule_condition :: Lens' RoutingRule (Maybe Condition) Source #

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

routingRule_redirect :: Lens' RoutingRule Redirect Source #

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

S3KeyFilter

s3KeyFilter_filterRules :: Lens' S3KeyFilter (Maybe [FilterRule]) Source #

Undocumented member.

S3Location

s3Location_accessControlList :: Lens' S3Location (Maybe [Grant]) Source #

A list of grants that control access to the staged results.

s3Location_cannedACL :: Lens' S3Location (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the restore results.

s3Location_encryption :: Lens' S3Location (Maybe Encryption) Source #

Undocumented member.

s3Location_storageClass :: Lens' S3Location (Maybe StorageClass) Source #

The class of storage used to store the restore results.

s3Location_tagging :: Lens' S3Location (Maybe Tagging) Source #

The tag-set that is applied to the restore results.

s3Location_userMetadata :: Lens' S3Location (Maybe [MetadataEntry]) Source #

A list of metadata to store with the restore results in S3.

s3Location_bucketName :: Lens' S3Location BucketName Source #

The name of the bucket where the restore results will be placed.

s3Location_prefix :: Lens' S3Location Text Source #

The prefix that is prepended to the restore results for this request.

S3ServiceError

s3ServiceError_code :: Lens' S3ServiceError (Maybe Text) Source #

The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.

Amazon S3 error codes

- Code: AccessDenied
- Description: Access Denied
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AccountProblem
- Description: There is a problem with your Amazon Web Services account that prevents the action from completing successfully. Contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AllAccessDisabled
- Description: All access to this Amazon S3 resource has been disabled. Contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: AmbiguousGrantByEmailAddress
- Description: The email address you provided is associated with more than one account.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: AuthorizationHeaderMalformed
- Description: The authorization header you provided is invalid.
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: N/A
- Code: BadDigest
- Description: The Content-MD5 you specified did not match what we received.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: BucketAlreadyExists
- Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: BucketAlreadyOwnedByYou
- Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
- Code: 409 Conflict (in all Regions except the North Virginia Region)
- SOAP Fault Code Prefix: Client
- Code: BucketNotEmpty
- Description: The bucket you tried to delete is not empty.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: CredentialsNotSupported
- Description: This request does not support credentials.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: CrossLocationLoggingProhibited
- Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: EntityTooSmall
- Description: Your proposed upload is smaller than the minimum allowed object size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: EntityTooLarge
- Description: Your proposed upload exceeds the maximum allowed object size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: ExpiredToken
- Description: The provided token has expired.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IllegalVersioningConfigurationException
- Description: Indicates that the versioning configuration specified in the request is invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IncompleteBody
- Description: You did not provide the number of bytes specified by the Content-Length HTTP header
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: IncorrectNumberOfFilesInPostRequest
- Description: POST requires exactly one file upload per request.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InlineDataTooLarge
- Description: Inline data exceeds the maximum allowed size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InternalError
- Description: We encountered an internal error. Please try again.
- HTTP Status Code: 500 Internal Server Error
- SOAP Fault Code Prefix: Server
- Code: InvalidAccessKeyId
- Description: The Amazon Web Services access key ID you provided does not exist in our records.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidAddressingHeader
- Description: You must specify the Anonymous role.
- HTTP Status Code: N/A
- SOAP Fault Code Prefix: Client
- Code: InvalidArgument
- Description: Invalid Argument
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidBucketName
- Description: The specified bucket is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidBucketState
- Description: The request is not valid with the current state of the bucket.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: InvalidDigest
- Description: The Content-MD5 you specified is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidEncryptionAlgorithmError
- Description: The encryption request you specified is not valid. The valid value is AES256.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidLocationConstraint
- Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidObjectState
- Description: The action is not valid for the current state of the object.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidPart
- Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidPartOrder
- Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidPayer
- Description: All access to this object has been disabled. Please contact Amazon Web Services Support for further assistance.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidPolicyDocument
- Description: The content of the form does not meet the conditions specified in the policy document.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidRange
- Description: The requested range cannot be satisfied.
- HTTP Status Code: 416 Requested Range Not Satisfiable
- SOAP Fault Code Prefix: Client
- Code: InvalidRequest
- Description: Please use AWS4-HMAC-SHA256.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: SOAP requests must be made over an HTTPS connection.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact Amazon Web Services Support for more information.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidRequest
- Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact Amazon Web Services Support for more information.
- HTTP Status Code: 400 Bad Request
- Code: N/A
- Code: InvalidSecurity
- Description: The provided security credentials are not valid.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: InvalidSOAPRequest
- Description: The SOAP request body is invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidStorageClass
- Description: The storage class you specified is not valid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidTargetBucketForLogging
- Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidToken
- Description: The provided token is malformed or otherwise invalid.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: InvalidURI
- Description: Couldn't parse the specified URI.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: KeyTooLongError
- Description: Your key is too long.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedACLError
- Description: The XML you provided was not well-formed or did not validate against our published schema.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedPOSTRequest
- Description: The body of your POST request is not well-formed multipart/form-data.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MalformedXML
- Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema."
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MaxMessageLengthExceeded
- Description: Your request was too big.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MaxPostPreDataLengthExceededError
- Description: Your POST request fields preceding the upload file were too large.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MetadataTooLarge
- Description: Your metadata headers exceed the maximum allowed metadata size.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MethodNotAllowed
- Description: The specified method is not allowed against this resource.
- HTTP Status Code: 405 Method Not Allowed
- SOAP Fault Code Prefix: Client
- Code: MissingAttachment
- Description: A SOAP attachment was expected, but none were found.
- HTTP Status Code: N/A
- SOAP Fault Code Prefix: Client
- Code: MissingContentLength
- Description: You must provide the Content-Length HTTP header.
- HTTP Status Code: 411 Length Required
- SOAP Fault Code Prefix: Client
- Code: MissingRequestBodyError
- Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty."
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MissingSecurityElement
- Description: The SOAP 1.1 request is missing a security element.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: MissingSecurityHeader
- Description: Your request is missing a required header.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: NoLoggingStatusForKey
- Description: There is no such thing as a logging status subresource for a key.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: NoSuchBucket
- Description: The specified bucket does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchBucketPolicy
- Description: The specified bucket does not have a bucket policy.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchKey
- Description: The specified key does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchUpload
- Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NoSuchVersion
- Description: Indicates that the version ID specified in the request does not match an existing version.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client
- Code: NotImplemented
- Description: A header you provided implies functionality that is not implemented.
- HTTP Status Code: 501 Not Implemented
- SOAP Fault Code Prefix: Server
- Code: NotSignedUp
- Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: Amazon S3
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: OperationAborted
- Description: A conflicting conditional action is currently in progress against this resource. Try again.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: PermanentRedirect
- Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
- HTTP Status Code: 301 Moved Permanently
- SOAP Fault Code Prefix: Client
- Code: PreconditionFailed
- Description: At least one of the preconditions you specified did not hold.
- HTTP Status Code: 412 Precondition Failed
- SOAP Fault Code Prefix: Client
- Code: Redirect
- Description: Temporary redirect.
- HTTP Status Code: 307 Moved Temporarily
- SOAP Fault Code Prefix: Client
- Code: RestoreAlreadyInProgress
- Description: Object restore is already in progress.
- HTTP Status Code: 409 Conflict
- SOAP Fault Code Prefix: Client
- Code: RequestIsNotMultiPartContent
- Description: Bucket POST must be of the enclosure-type multipart/form-data.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: RequestTimeout
- Description: Your socket connection to the server was not read from or written to within the timeout period.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: RequestTimeTooSkewed
- Description: The difference between the request time and the server's time is too large.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: RequestTorrentOfBucketError
- Description: Requesting the torrent file of a bucket is not permitted.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: SignatureDoesNotMatch
- Description: The request signature we calculated does not match the signature you provided. Check your Amazon Web Services secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
- HTTP Status Code: 403 Forbidden
- SOAP Fault Code Prefix: Client
- Code: ServiceUnavailable
- Description: Reduce your request rate.
- HTTP Status Code: 503 Service Unavailable
- SOAP Fault Code Prefix: Server
- Code: SlowDown
- Description: Reduce your request rate.
- HTTP Status Code: 503 Slow Down
- SOAP Fault Code Prefix: Server
- Code: TemporaryRedirect
- Description: You are being redirected to the bucket while DNS updates.
- HTTP Status Code: 307 Moved Temporarily
- SOAP Fault Code Prefix: Client
- Code: TokenRefreshRequired
- Description: The provided token must be refreshed.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: TooManyBuckets
- Description: You have attempted to create more buckets than allowed.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UnexpectedContent
- Description: This request does not support content.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UnresolvableGrantByEmailAddress
- Description: The email address you provided does not match any account on record.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client
- Code: UserKeyMustBeSpecified
- Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
- HTTP Status Code: 400 Bad Request
- SOAP Fault Code Prefix: Client

s3ServiceError_key :: Lens' S3ServiceError (Maybe ObjectKey) Source #

The error key.

s3ServiceError_message :: Lens' S3ServiceError (Maybe Text) Source #

The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

s3ServiceError_versionId :: Lens' S3ServiceError (Maybe ObjectVersionId) Source #

The version ID of the error.

SSEKMS

ssekms_keyId :: Lens' SSEKMS Text Source #

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

SSES3

ScanRange

scanRange_end :: Lens' ScanRange (Maybe Integer) Source #

Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

scanRange_start :: Lens' ScanRange (Maybe Integer) Source #

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file. For example, <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

SelectObjectContentEventStream

selectObjectContentEventStream_cont :: Lens' SelectObjectContentEventStream (Maybe ContinuationEvent) Source #

The Continuation Event.

selectObjectContentEventStream_end :: Lens' SelectObjectContentEventStream (Maybe EndEvent) Source #

The End Event.

selectObjectContentEventStream_progress :: Lens' SelectObjectContentEventStream (Maybe ProgressEvent) Source #

The Progress Event.

selectObjectContentEventStream_records :: Lens' SelectObjectContentEventStream (Maybe RecordsEvent) Source #

The Records Event.

selectObjectContentEventStream_stats :: Lens' SelectObjectContentEventStream (Maybe StatsEvent) Source #

The Stats Event.

SelectParameters

selectParameters_inputSerialization :: Lens' SelectParameters InputSerialization Source #

Describes the serialization format of the object.

selectParameters_expressionType :: Lens' SelectParameters ExpressionType Source #

The type of the provided expression (for example, SQL).

selectParameters_expression :: Lens' SelectParameters Text Source #

The expression that is used to query the object.

selectParameters_outputSerialization :: Lens' SelectParameters OutputSerialization Source #

Describes how the results of the Select job are serialized.

ServerSideEncryptionByDefault

serverSideEncryptionByDefault_kmsMasterKeyID :: Lens' ServerSideEncryptionByDefault (Maybe Text) Source #

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

serverSideEncryptionByDefault_sSEAlgorithm :: Lens' ServerSideEncryptionByDefault ServerSideEncryption Source #

Server-side encryption algorithm to use for the default encryption.

ServerSideEncryptionConfiguration

serverSideEncryptionConfiguration_rules :: Lens' ServerSideEncryptionConfiguration [ServerSideEncryptionRule] Source #

Container for information about a particular server-side encryption configuration rule.

ServerSideEncryptionRule

serverSideEncryptionRule_applyServerSideEncryptionByDefault :: Lens' ServerSideEncryptionRule (Maybe ServerSideEncryptionByDefault) Source #

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

serverSideEncryptionRule_bucketKeyEnabled :: Lens' ServerSideEncryptionRule (Maybe Bool) Source #

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

SourceSelectionCriteria

sourceSelectionCriteria_replicaModifications :: Lens' SourceSelectionCriteria (Maybe ReplicaModifications) Source #

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed

sourceSelectionCriteria_sseKmsEncryptedObjects :: Lens' SourceSelectionCriteria (Maybe SseKmsEncryptedObjects) Source #

A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

SseKmsEncryptedObjects

sseKmsEncryptedObjects_status :: Lens' SseKmsEncryptedObjects SseKmsEncryptedObjectsStatus Source #

Specifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

Stats

stats_bytesProcessed :: Lens' Stats (Maybe Integer) Source #

The total number of uncompressed object bytes processed.

stats_bytesReturned :: Lens' Stats (Maybe Integer) Source #

The total number of bytes of records payload data returned.

stats_bytesScanned :: Lens' Stats (Maybe Integer) Source #

The total number of object bytes scanned.

StatsEvent

statsEvent_details :: Lens' StatsEvent (Maybe Stats) Source #

The Stats event details.

StorageClassAnalysis

storageClassAnalysis_dataExport :: Lens' StorageClassAnalysis (Maybe StorageClassAnalysisDataExport) Source #

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

StorageClassAnalysisDataExport

storageClassAnalysisDataExport_outputSchemaVersion :: Lens' StorageClassAnalysisDataExport StorageClassAnalysisSchemaVersion Source #

The version of the output schema to use when exporting data. Must be V_1.

storageClassAnalysisDataExport_destination :: Lens' StorageClassAnalysisDataExport AnalyticsExportDestination Source #

The place to store the data for an analysis.

Tag

tag_key :: Lens' Tag ObjectKey Source #

Name of the object key.

tag_value :: Lens' Tag Text Source #

Value of the tag.

Tagging

tagging_tagSet :: Lens' Tagging [Tag] Source #

A collection for a set of tags

TargetGrant

targetGrant_grantee :: Lens' TargetGrant (Maybe Grantee) Source #

Container for the person being granted permissions.

targetGrant_permission :: Lens' TargetGrant (Maybe BucketLogsPermission) Source #

Logging permissions assigned to the grantee for the bucket.

Tiering

tiering_days :: Lens' Tiering Int Source #

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

tiering_accessTier :: Lens' Tiering IntelligentTieringAccessTier Source #

S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

TopicConfiguration

topicConfiguration_filter :: Lens' TopicConfiguration (Maybe NotificationConfigurationFilter) Source #

Undocumented member.

topicConfiguration_id :: Lens' TopicConfiguration (Maybe Text) Source #

Undocumented member.

topicConfiguration_topicArn :: Lens' TopicConfiguration Text Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

topicConfiguration_events :: Lens' TopicConfiguration [Event] Source #

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

Transition

transition_date :: Lens' Transition (Maybe UTCTime) Source #

Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

transition_days :: Lens' Transition (Maybe Int) Source #

Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

transition_storageClass :: Lens' Transition (Maybe TransitionStorageClass) Source #

The storage class to which you want the object to transition.

VersioningConfiguration

versioningConfiguration_mfaDelete :: Lens' VersioningConfiguration (Maybe MFADelete) Source #

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

versioningConfiguration_status :: Lens' VersioningConfiguration (Maybe BucketVersioningStatus) Source #

The versioning state of the bucket.

WebsiteConfiguration

websiteConfiguration_errorDocument :: Lens' WebsiteConfiguration (Maybe ErrorDocument) Source #

The name of the error document for the website.

websiteConfiguration_indexDocument :: Lens' WebsiteConfiguration (Maybe IndexDocument) Source #

The name of the index document for the website.

websiteConfiguration_redirectAllRequestsTo :: Lens' WebsiteConfiguration (Maybe RedirectAllRequestsTo) Source #

The redirect behavior for every request to this bucket's website endpoint.

If you specify this property, you can't specify any other property.

websiteConfiguration_routingRules :: Lens' WebsiteConfiguration (Maybe [RoutingRule]) Source #

Rules that define when a redirect is applied and the redirect behavior.