Package-Level Type Names (total 509, in which 219 are exported)
/* sort exporteds by: | */
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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).
Key of the object for which the multipart upload was initiated.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Upload ID that identifies the multipart upload.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( AbortMultipartUploadInput) noSmithyDocumentSerde()
AbortMultipartUploadInput : github.com/aws/smithy-go/document.noSerde
func (*Client).AbortMultipartUpload(ctx context.Context, params *AbortMultipartUploadInput, optFns ...func(*Options)) (*AbortMultipartUploadOutput, error)
func awsRestxml_serializeOpHttpBindingsAbortMultipartUploadInput(v *AbortMultipartUploadInput, encoder *httpbinding.Encoder) error
func validateOpAbortMultipartUploadInput(v *AbortMultipartUploadInput) error
BucketExistsWaiter defines the waiters for BucketExists
clientHeadBucketAPIClientoptionsBucketExistsWaiterOptions
Wait calls the waiter function for BucketExists waiter. The maxWaitDur is the
maximum wait duration the waiter will wait. The maxWaitDur is required and must
be greater than zero.
WaitForOutput calls the waiter function for BucketExists waiter and returns the
output of the successful operation. The maxWaitDur is the maximum wait duration
the waiter will wait. The maxWaitDur is required and must be greater than zero.
func NewBucketExistsWaiter(client HeadBucketAPIClient, optFns ...func(*BucketExistsWaiterOptions)) *BucketExistsWaiter
BucketExistsWaiterOptions are waiter options for BucketExistsWaiter
Set of options to modify how an operation is invoked. These apply to all
operations invoked for this client. Use functional options on operation call to
modify this list for per operation behavior.
LogWaitAttempts is used to enable logging for waiter retry attempts
MaxDelay is the maximum amount of time to delay between retries. If unset or set
to zero, BucketExistsWaiter will use default max delay of 120 seconds. Note that
MaxDelay must resolve to value greater than or equal to the MinDelay.
MinDelay is the minimum amount of time to delay between retries. If unset,
BucketExistsWaiter will use default minimum delay of 5 seconds. Note that
MinDelay must resolve to a value lesser than or equal to the MaxDelay.
Retryable is function that can be used to override the service defined
waiter-behavior based on operation output, or returned error. This function is
used by the waiter to decide if a state is retryable or a terminal state. By
default service-modeled logic will populate this option. This option can thus be
used to define a custom waiter state with fall-back to service-modeled waiter
state mutators.The function returns an error in case of a failure state. In case
of retry state, this function returns a bool value of true and nil error, while
in case of success it returns a bool value of false and nil error.
BucketNotExistsWaiter defines the waiters for BucketNotExists
clientHeadBucketAPIClientoptionsBucketNotExistsWaiterOptions
Wait calls the waiter function for BucketNotExists waiter. The maxWaitDur is the
maximum wait duration the waiter will wait. The maxWaitDur is required and must
be greater than zero.
WaitForOutput calls the waiter function for BucketNotExists waiter and returns
the output of the successful operation. The maxWaitDur is the maximum wait
duration the waiter will wait. The maxWaitDur is required and must be greater
than zero.
func NewBucketNotExistsWaiter(client HeadBucketAPIClient, optFns ...func(*BucketNotExistsWaiterOptions)) *BucketNotExistsWaiter
BucketNotExistsWaiterOptions are waiter options for BucketNotExistsWaiter
Set of options to modify how an operation is invoked. These apply to all
operations invoked for this client. Use functional options on operation call to
modify this list for per operation behavior.
LogWaitAttempts is used to enable logging for waiter retry attempts
MaxDelay is the maximum amount of time to delay between retries. If unset or set
to zero, BucketExistsWaiter will use default max delay of 120 seconds. Note that
MaxDelay must resolve to value greater than or equal to the MinDelay.
MinDelay is the minimum amount of time to delay between retries. If unset,
BucketExistsWaiter will use default minimum delay of 5 seconds. Note that
MinDelay must resolve to a value lesser than or equal to the MaxDelay.
Retryable is function that can be used to override the service defined
waiter-behavior based on operation output, or returned error. This function is
used by the waiter to decide if a state is retryable or a terminal state. By
default service-modeled logic will populate this option. This option can thus be
used to define a custom waiter state with fall-back to service-modeled waiter
state mutators.The function returns an error in case of a failure state. In case
of retry state, this function returns a bool value of true and nil error, while
in case of success it returns a bool value of false and nil error.
ChecksumValidationMetadata contains metadata such as the checksum algorithm used
for data integrity validation.
AlgorithmsUsed is the set of the checksum algorithms used to validate the
response payload. The response payload must be completely read in order for the
checksum validation to be performed. An error is returned by the operation
output's response io.ReadCloser if the computed checksums are invalid.
func GetChecksumValidationMetadata(m middleware.Metadata) (ChecksumValidationMetadata, bool)
Client provides the API client to make operations call for Amazon Simple Storage
Service.
optionsOptions
This action aborts a multipart upload. After a multipart upload is aborted, no
additional parts can be uploaded using that upload ID. The storage consumed by
any previously uploaded parts will be freed. However, if any part uploads are
currently in progress, those part uploads might or might not succeed. As a
result, it might be necessary to abort a given multipart upload multiple times
in order to completely free all storage consumed by all parts. To verify that
all parts have been removed, so you don't get charged for the part storage, you
should call the ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) action and
ensure that the parts list is empty. For information about permissions required
to use the multipart upload, see Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The
following operations are related to AbortMultipartUpload:
*
CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Completes a multipart upload by assembling previously uploaded parts. You first
initiate the multipart upload and then upload all parts using the UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) operation.
After successfully uploading all relevant parts of an upload, you call this
action to complete the upload. Upon receiving this request, Amazon S3
concatenates all the parts in ascending order by part number to create a new
object. In the Complete Multipart Upload request, you must provide the parts
list. You must ensure that the parts list is complete. This action concatenates
the parts that you provide in the list. For each part in the list, you must
provide the part number and the ETag value, returned after that part was
uploaded. Processing of a Complete Multipart Upload request could take several
minutes to complete. After Amazon S3 begins processing the request, it sends an
HTTP response header that specifies a 200 OK response. While processing is in
progress, Amazon S3 periodically sends white space characters to keep the
connection from timing out. Because a request could fail after the initial 200
OK response has been sent, it is important that you check the response body to
determine whether the request succeeded. Note that if CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more
information, see Amazon S3 Error Best Practices
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html). You
cannot use Content-Type: application/x-www-form-urlencoded with Complete
Multipart Upload requests. Also, if you do not provide a Content-Type header,
CompleteMultipartUpload returns a 200 OK response. For more information about
multipart uploads, see Uploading Objects Using Multipart Upload
(https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For
information about permissions required to use the multipart upload API, see
Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
CompleteMultipartUpload has the following special errors:
* Error code:
EntityTooSmall
* Description: Your proposed upload is smaller than the minimum
allowed object size. Each part must be at least 5 MB in size, except the last
part.
* 400 Bad Request
* Error 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.
* 400 Bad Request
* Error code: InvalidPartOrder
* Description: The list
of parts was not in ascending order. The parts list must be specified in order
by part number.
* 400 Bad Request
* Error 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.
* 404 Not
Found
The following operations are related to CompleteMultipartUpload:
*
CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Creates a copy of an object that is already stored in Amazon S3. You can store
individual objects of up to 5 TB in Amazon S3. You create a copy of your object
up to 5 GB in size in a single atomic action using this API. However, to copy an
object greater than 5 GB, you must use the multipart upload Upload Part - Copy
(UploadPartCopy) API. For more information, see Copy Object Using the REST
Multipart Upload API
(https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html).
All copy requests must be authenticated. Additionally, you must have read access
to the source object and write access to the destination bucket. For more
information, see REST Authentication
(https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). Both
the Region that you want to copy the object from and the Region that you want to
copy the object to must be enabled for your account. A copy request might return
an error when Amazon S3 receives the copy request or while Amazon S3 is copying
the files. If the error occurs before the copy action starts, you receive a
standard Amazon S3 error. If the error occurs during the copy operation, the
error response is embedded in the 200 OK response. This means that a 200 OK
response can contain either a success or an error. Design your application to
parse the contents of the response and handle it appropriately. If the copy is
successful, you receive a response with information about the copied object. If
the request is an HTTP 1.1 request, the response is chunk encoded. If it were
not, it would not contain the content-length, and you would need to read the
entire body. The copy request charge is based on the storage class and Region
that you specify for the destination object. For pricing information, see Amazon
S3 pricing (http://aws.amazon.com/s3/pricing/). Amazon S3 transfer acceleration
does not support cross-Region copies. If you request a cross-Region copy using a
transfer acceleration endpoint, you get a 400 Bad Request error. For more
information, see Transfer Acceleration
(https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
Metadata When copying an object, you can preserve all metadata (default) or
specify new metadata. However, the ACL is not preserved and is set to private
for the user making the request. To override the default ACL setting, specify a
new ACL when generating a copy request. For more information, see Using ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To
specify whether you want the object metadata copied from the source object or
replaced with metadata provided in the request, you can optionally add the
x-amz-metadata-directive header. When you grant permissions, you can use the
s3:x-amz-metadata-directive condition key to enforce certain metadata behavior
when objects are uploaded. For more information, see Specifying Conditions in a
Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) in
the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition
keys, see Actions, Resources, and Condition Keys for Amazon S3
(https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html).
x-amz-copy-source-if Headers To only copy an object under certain conditions,
such as whether the Etag matches or whether the object was modified before or
after a specified date, use the following request parameters:
*
x-amz-copy-source-if-match
* x-amz-copy-source-if-none-match
*
x-amz-copy-source-if-unmodified-since
* x-amz-copy-source-if-modified-since
If
both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns
200 OK and copies the data:
* x-amz-copy-source-if-match condition evaluates to
true
* x-amz-copy-source-if-unmodified-since condition evaluates to false
If
both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns
the 412 Precondition Failed response code:
* x-amz-copy-source-if-none-match
condition evaluates to false
* x-amz-copy-source-if-modified-since condition
evaluates to true
All headers with the x-amz- prefix, including
x-amz-copy-source, must be signed. Server-side encryption When you perform a
CopyObject operation, you can optionally use the appropriate encryption-related
headers to encrypt the object using server-side encryption with Amazon Web
Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided
encryption key. With server-side encryption, Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts the data when you access it.
For more information about server-side encryption, see Using Server-Side
Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). If
a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.
For more information, see Amazon S3 Bucket Keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the Amazon
S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying
an object, you can optionally use headers to grant ACL-based permissions. By
default, all objects are private. Only the owner has full access control. When
adding a new object, you can grant permissions to individual Amazon Web Services
accounts or to predefined groups defined by Amazon S3. These permissions are
then added to the ACL on the object. For more information, see Access Control
List (ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing
ACLs Using the REST API
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). If
the bucket that you're copying objects to uses the bucket owner enforced setting
for S3 Object Ownership, ACLs are disabled and no longer affect permissions.
Buckets that use this setting only accept PUT requests that don't specify an ACL
or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed
in the XML format. For more information, see Controlling ownership of objects
and disabling ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced
setting for Object Ownership, all objects written to the bucket by any account
will be owned by the bucket owner. Checksums When copying an object, if it has a
checksum, that checksum will be copied to the new object by default. When you
copy the object over, you may optionally specify a different checksum algorithm
to use with the x-amz-checksum-algorithm header. Storage Class Options You can
use the CopyObject action to change the storage class of an object that is
already stored in Amazon S3 using the StorageClass parameter. For more
information, see Storage Classes
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in
the Amazon S3 User Guide. Versioning By default, x-amz-copy-source identifies
the current version of an object to copy. If the current version is a delete
marker, Amazon S3 behaves as if the object was deleted. To copy a different
version, use the versionId subresource. If you enable versioning on the target
bucket, Amazon S3 generates a unique version ID for the object being copied.
This version ID is different from the version ID of the source object. Amazon S3
returns the version ID of the copied object in the x-amz-version-id response
header in the response. If you do not enable versioning or suspend it on the
target bucket, the version ID that Amazon S3 generates is always null. If the
source object's storage class is GLACIER, you must restore a copy of this object
before you can use it as a source object for the copy operation. For more
information, see RestoreObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). The
following operations are related to CopyObject:
* PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
For more
information, see Copying Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html).
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3
and have a valid Amazon Web Services Access Key ID to authenticate requests.
Anonymous requests are never allowed to create buckets. By creating the bucket,
you become the bucket owner. Not every string is an acceptable bucket name. For
information about bucket naming restrictions, see Bucket naming rules
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html).
By default, the bucket is created in the US East (N. Virginia) Region. You can
optionally specify a Region in the request body. You might choose a Region to
optimize latency, minimize costs, or address regulatory requirements. For
example, if you reside in Europe, you will probably find it advantageous to
create buckets in the Europe (Ireland) Region. For more information, see
Accessing a bucket
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).
If you send your create bucket request to the s3.amazonaws.com endpoint, the
request goes to the us-east-1 Region. Accordingly, the signature calculations in
Signature Version 4 must use us-east-1 as the Region, even if the location
constraint in the request specifies another Region where the bucket is to be
created. If you create a bucket in a Region other than US East (N. Virginia),
your application must be able to handle 307 redirect. For more information, see
Virtual hosting of buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html). Access
control lists (ACLs) When creating a bucket using this operation, you can
optionally configure the bucket ACL to specify the accounts or groups that
should be granted specific permissions on the bucket. If your CreateBucket
request sets bucket owner enforced for S3 Object Ownership and specifies a
bucket ACL that provides access to an external Amazon Web Services account, your
request fails with a 400 error and returns the
InvalidBucketAclWithObjectOwnership error code. For more information, see
Controlling object ownership
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. There are two ways to grant the appropriate
permissions using the request headers.
* Specify a canned ACL using the
x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as
canned ACLs. Each canned ACL has a predefined set of grantees and permissions.
For more information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*
Specify access permissions explicitly using the x-amz-grant-read,
x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and
x-amz-grant-full-control headers. These headers map to the set of permissions
Amazon S3 supports in an ACL. For more information, see Access control list
(ACL) overview
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html). You
specify each grantee as a type=value pair, where the type is one of the
following:
* id – if the value specified is the canonical user ID of an Amazon
Web Services account
* uri – if you are granting permissions to a predefined
group
* emailAddress – if the value specified is the email address of an Amazon
Web Services account 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
For example, the following
x-amz-grant-read header grants the Amazon Web Services accounts identified by
account IDs permissions to read object data and its metadata: x-amz-grant-read:
id="11112222333", id="444455556666"
You can use either a canned ACL or specify
access permissions explicitly. You cannot do both. Permissions In addition to
s3:CreateBucket, the following permissions are required when your CreateBucket
includes specific headers:
* ACLs - If your CreateBucket request specifies ACL
permissions and the ACL is public-read, public-read-write, authenticated-read,
or if you specify access permissions explicitly through any other ACL, both
s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the
CreateBucket request is private or doesn't specify any ACLs, only
s3:CreateBucket permission is needed.
* Object Lock - If
ObjectLockEnabledForBucket is set to true in your CreateBucket request,
s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are
required.
* S3 Object Ownership - If your CreateBucket request includes the the
x-amz-object-ownership header, s3:PutBucketOwnershipControls permission is
required.
The following operations are related to CreateBucket:
* PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
DeleteBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
This action initiates a multipart upload and returns an upload ID. This upload
ID is used to associate all of the parts in the specific multipart upload. You
specify this upload ID in each of your subsequent upload part requests (see
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)). You also
include this upload ID in the final request to either complete or abort the
multipart upload request. For more information about multipart uploads, see
Multipart Upload Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). If you have
configured a lifecycle rule to abort incomplete multipart uploads, the upload
must complete within the number of days specified in the bucket lifecycle
configuration. Otherwise, the incomplete multipart upload becomes eligible for
an abort action and Amazon S3 aborts the multipart upload. For more information,
see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
For information about the permissions required to use the multipart upload API,
see Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). For
request signing, multipart upload is just a series of regular requests. You
initiate a multipart upload, send one or more requests to upload parts, and then
complete the multipart upload process. You sign each request individually. There
is nothing special about signing multipart upload requests. For more information
about signing, see Authenticating Requests (Amazon Web Services Signature
Version 4)
(https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
After you initiate a multipart upload and upload one or more parts, to stop
being charged for storing the uploaded parts, you must either complete or abort
the multipart upload. Amazon S3 frees up the space used to store the parts and
stop charging you for storing them only after you either complete or abort a
multipart upload. You can optionally request server-side encryption. For
server-side encryption, Amazon S3 encrypts your data as it writes it to disks in
its data centers and decrypts it when you access it. You can provide your own
encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed
encryption keys. If you choose to provide your own encryption key, the request
headers you provide in UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) and
UploadPartCopy
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
requests must match the headers you used in the request to initiate the upload
by using CreateMultipartUpload. To perform a multipart upload with encryption
using an Amazon Web Services KMS key, the requester must have permission to the
kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are
required because Amazon S3 must decrypt and read data from the encrypted file
parts before it completes the multipart upload. For more information, see
Multipart upload API and permissions
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user
or role is in the same Amazon Web Services account as the KMS key, then you must
have these permissions on the key policy. If your IAM user or role belongs to a
different account than the key, then you must have the permissions on both the
key policy and your IAM user or role. For more information, see Protecting Data
Using Server-Side Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html).
Access Permissions When copying an object, you can optionally specify the
accounts or groups that should be granted specific permissions on the new
object. There are two ways to grant the permissions using the request
headers:
* Specify a canned ACL with the x-amz-acl request header. For more
information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*
Specify access permissions explicitly with the x-amz-grant-read,
x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports
in an ACL. For more information, see Access Control List (ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
You can
use either a canned ACL or specify access permissions explicitly. You cannot do
both. Server-Side- Encryption-Specific Request Headers You can optionally tell
Amazon S3 to encrypt data at rest using server-side encryption. Server-side
encryption is for data encryption at rest. Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it. The
option you use depends on whether you want to use Amazon Web Services managed
encryption keys or provide your own encryption key.
* Use encryption keys
managed by Amazon S3 or customer managed key stored in Amazon Web Services Key
Management Service (Amazon Web Services KMS) – If you want Amazon Web Services
to manage the keys used to encrypt data, specify the following headers in the
request.
* x-amz-server-side-encryption
*
x-amz-server-side-encryption-aws-kms-key-id
*
x-amz-server-side-encryption-context
If you specify
x-amz-server-side-encryption:aws:kms, but don't provide
x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web
Services managed key in Amazon Web Services KMS to protect the data. All GET and
PUT requests for an object protected by Amazon Web Services KMS fail if you
don't make them with SSL or by using SigV4. For more information about
server-side encryption with KMS key (SSE-KMS), see Protecting Data Using
Server-Side Encryption with KMS keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).
*
Use customer-provided encryption keys – If you want to manage your own
encryption keys, provide all the following headers in the request.
*
x-amz-server-side-encryption-customer-algorithm
*
x-amz-server-side-encryption-customer-key
*
x-amz-server-side-encryption-customer-key-MD5
For more information about
server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using
Server-Side Encryption with KMS keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).
Access-Control-List
(ACL)-Specific Request Headers You also can use the following access
control–related headers with this operation. By default, all objects are
private. Only the owner has full access control. When adding a new object, you
can grant permissions to individual Amazon Web Services accounts or to
predefined groups defined by Amazon S3. These permissions are then added to the
access control list (ACL) on the object. For more information, see Using ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). With
this operation, you can grant access permissions using one of the following two
methods:
* Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of
predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of
grantees and permissions. For more information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*
Specify access permissions explicitly — To explicitly grant access permissions
to specific Amazon Web Services accounts or groups, use the following headers.
Each header maps to specific permissions that Amazon S3 supports in an ACL. For
more information, see Access Control List (ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). In the
header, you specify a list of grantees who get the specific permission. To grant
permissions explicitly, use:
* x-amz-grant-read
* x-amz-grant-write
*
x-amz-grant-read-acp
* x-amz-grant-write-acp
* x-amz-grant-full-control
You
specify each grantee as a type=value pair, where the type is one of the
following:
* id – if the value specified is the canonical user ID of an Amazon
Web Services account
* uri – if you are granting permissions to a predefined
group
* emailAddress – if the value specified is the email address of an Amazon
Web Services account 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
For example, the following
x-amz-grant-read header grants the Amazon Web Services accounts identified by
account IDs permissions to read object data and its metadata: x-amz-grant-read:
id="11112222333", id="444455556666"
The following operations are related to
CreateMultipartUpload:
* UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Deletes the S3 bucket. All objects (including all object versions and delete
markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
Deletes an analytics configuration for the bucket (specified by the analytics
configuration ID). To use this operation, you must have permissions to perform
the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics –
Storage Class Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
The following operations are related to DeleteBucketAnalyticsConfiguration:
*
GetBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
ListBucketAnalyticsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
*
PutBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
Deletes the cors configuration information set for the bucket. To use this
operation, you must have permission to perform the s3:PutBucketCORS action. The
bucket owner has this permission by default and can grant this permission to
others. For information about cors, see Enabling Cross-Origin Resource Sharing
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3
User Guide. Related Resources:
* PutBucketCors
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
*
RESTOPTIONSobject
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
This implementation of the DELETE action removes default encryption from the
bucket. For information about the Amazon S3 default encryption feature, see
Amazon S3 Default Bucket Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the
Amazon S3 User Guide. To use this operation, you must have permissions to
perform the s3:PutEncryptionConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket
Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. Related Resources
* PutBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
*
GetBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
Deletes the S3 Intelligent-Tiering configuration from the specified bucket. The
S3 Intelligent-Tiering storage class is designed to optimize storage costs by
automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with
unknown, changing, or unpredictable access patterns, independent of object size
or retention period. If the size of an object is less than 128 KB, it is not
monitored and not eligible for auto-tiering. Smaller objects can be stored, but
they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class. For more information, see Storage class for
automatically optimizing frequently and infrequently accessed objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to DeleteBucketIntelligentTieringConfiguration include:
*
GetBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
*
PutBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
ListBucketIntelligentTieringConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
Deletes an inventory configuration (identified by the inventory ID) from the
bucket. To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).
Operations related to DeleteBucketInventoryConfiguration include:
*
GetBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
PutBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
*
ListBucketInventoryConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes
all the lifecycle configuration rules in the lifecycle subresource associated
with the bucket. Your objects never expire, and Amazon S3 no longer
automatically deletes any objects on the basis of rules contained in the deleted
lifecycle configuration. To use this operation, you must have permission to
perform the s3:PutLifecycleConfiguration action. By default, the bucket owner
has this permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully
propagated to all the Amazon S3 systems. For more information about the object
expiration, see Elements to Describe Lifecycle Actions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).
Related actions include:
* PutBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
*
GetBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
Deletes a metrics configuration for the Amazon CloudWatch request metrics
(specified by the metrics configuration ID) from the bucket. Note that this
doesn't include the daily storage metrics. To use this operation, you must have
permissions to perform the s3:PutMetricsConfiguration action. The bucket owner
has this permission by default. The bucket owner can grant this permission to
others. For more information about permissions, see Permissions Related to
Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see Monitoring
Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to DeleteBucketMetricsConfiguration:
*
GetBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
PutBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
ListBucketMetricsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
*
Monitoring Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you
must have the s3:PutBucketOwnershipControls permission. For more information
about Amazon S3 permissions, see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see Using Object Ownership
(https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html).
The following operations are related to DeleteBucketOwnershipControls:
*
GetBucketOwnershipControls
* PutBucketOwnershipControls
This implementation of the DELETE action uses the policy subresource to delete
the policy of a specified bucket. If you are using an identity other than the
root user of the Amazon Web Services account that owns the bucket, the calling
identity must have the DeleteBucketPolicy permissions on the specified bucket
and belong to the bucket owner's account to use this operation. If you don't
have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity
that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not
Allowed error. As a security precaution, the root user of the Amazon Web
Services account that owns a bucket can always use this operation, even if the
policy explicitly denies the root user the ability to perform this action. For
more information about bucket policies, see Using Bucket Policies and
UserPolicies
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The
following operations are related to DeleteBucketPolicy
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
Deletes the replication configuration from the bucket. To use this operation,
you must have permissions to perform the s3:PutReplicationConfiguration action.
The bucket owner has these permissions by default and can grant it to others.
For more information about permissions, see Permissions Related to Bucket
Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
It can take a while for the deletion of a replication configuration to fully
propagate. For information about replication configuration, see Replication
(https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon
S3 User Guide. The following operations are related to
DeleteBucketReplication:
* PutBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
*
GetBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
Deletes the tags from the bucket. To use this operation, you must have
permission to perform the s3:PutBucketTagging action. By default, the bucket
owner has this permission and can grant this permission to others. The following
operations are related to DeleteBucketTagging:
* GetBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
*
PutBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
This action removes the website configuration for a bucket. Amazon S3 returns a
200 OK response upon successfully deleting a website configuration on the
specified bucket. You will get a 200 OK response if the website configuration
you are trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if the bucket specified in the request does not exist. This DELETE
action requires the S3:DeleteBucketWebsite permission. By default, only the
bucket owner can delete the website configuration attached to a bucket. However,
bucket owners can grant other users permission to delete the website
configuration by writing a bucket policy granting them the
S3:DeleteBucketWebsite permission. For more information about hosting websites,
see Hosting Websites on Amazon S3
(https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). The
following operations are related to DeleteBucketWebsite:
* GetBucketWebsite
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html)
*
PutBucketWebsite
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
Removes the null version (if there is one) of an object and inserts a delete
marker, which becomes the latest version of the object. If there isn't a null
version, Amazon S3 does not remove any objects but will still respond that the
command was successful. To remove a specific version, you must be the bucket
owner and you must use the version Id subresource. Using this subresource
permanently deletes the version. If the object deleted is a delete marker,
Amazon S3 sets the response header, x-amz-delete-marker, to true. If the object
you want to delete is in a bucket where the bucket versioning configuration is
MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE
versionId request. Requests that include x-amz-mfa must use HTTPS. For more
information about MFA Delete, see Using MFA Delete
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html). To see
sample requests that use versioning, see Sample Request
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete).
You can delete objects by explicitly calling DELETE Object or configure its
lifecycle (PutBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html))
to enable Amazon S3 to remove them for you. If you want to block users or
accounts from removing or deleting objects from your bucket, you must deny them
the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
actions. The following action is related to DeleteObject:
* PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
Removes the entire tag set from the specified object. For more information about
managing object tags, see Object Tagging
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). To use
this operation, you must have permission to perform the s3:DeleteObjectTagging
action. To delete tags of a specific object version, add the versionId query
parameter in the request. You will need permission for the
s3:DeleteObjectVersionTagging action. The following operations are related to
DeleteBucketMetricsConfiguration:
* PutObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
*
GetObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
This action enables you to delete multiple objects from a bucket using a single
HTTP request. If you know the object keys that you want to delete, then this
action provides a suitable alternative to sending individual delete requests,
reducing per-request overhead. The request contains a list of up to 1000 keys
that you want to delete. In the XML, you provide the object key names, and
optionally, version IDs if you want to delete a specific version of the object
from a versioning-enabled bucket. For each key, Amazon S3 performs a delete
action and returns the result of that delete, success, or failure, in the
response. Note that if the object specified in the request is not found, Amazon
S3 returns the result as deleted. The action supports two modes for the
response: verbose and quiet. By default, the action uses verbose mode in which
the response includes the result of deletion of each key in your request. In
quiet mode the response includes only keys where the delete action encountered
an error. For a successful deletion, the action does not return any information
about the delete in the response body. When performing this action on an MFA
Delete enabled bucket, that attempts to delete any versioned objects, you must
include an MFA token. If you do not provide one, the entire request will fail,
even if there are non-versioned objects you are trying to delete. If you provide
an invalid token, whether there are versioned keys in the request or not, the
entire Multi-Object Delete request will fail. For information about MFA Delete,
see MFA Delete
(https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete).
Finally, the Content-MD5 header is required for all Multi-Object Delete
requests. Amazon S3 uses the header value to ensure that your request body has
not been altered in transit. The following operations are related to
DeleteObjects:
* CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this
operation, you must have the s3:PutBucketPublicAccessBlock permission. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The following operations are related to DeletePublicAccessBlock:
* Using Amazon
S3 Block Public Access
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
GetPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
PutPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
GetBucketPolicyStatus
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
This implementation of the GET action uses the accelerate subresource to return
the Transfer Acceleration state of a bucket, which is either Enabled or
Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that
enables you to perform faster data transfers to and from Amazon S3. To use this
operation, you must have permission to perform the s3:GetAccelerateConfiguration
action. The bucket owner has this permission by default. The bucket owner can
grant this permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. You set the Transfer Acceleration state of an
existing bucket to Enabled or Suspended by using the
PutBucketAccelerateConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html)
operation. A GET accelerate request does not return a state value for a bucket
that has no transfer acceleration state. A bucket has no Transfer Acceleration
state if a state has never been set on the bucket. For more information about
transfer acceleration, see Transfer Acceleration
(https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in
the Amazon S3 User Guide. Related Resources
* PutBucketAccelerateConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html)
This implementation of the GET action uses the acl subresource to return the
access control list (ACL) of a bucket. To use GET to return the ACL of the
bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is
granted to the anonymous user, you can return the ACL of the bucket without
using an authorization header. If your bucket uses the bucket owner enforced
setting for S3 Object Ownership, requests to read ACLs are still supported and
return the bucket-owner-full-control ACL with the owner being the account that
created the bucket. For more information, see Controlling object ownership and
disabling ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. Related Resources
* ListObjects
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
This implementation of the GET action returns an analytics configuration
(identified by the analytics configuration ID) from the bucket. To use this
operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can
grant this permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. For information about Amazon S3 analytics feature,
see Amazon S3 Analytics – Storage Class Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html)
in the Amazon S3 User Guide. Related Resources
*
DeleteBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
ListBucketAnalyticsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
*
PutBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
Returns the Cross-Origin Resource Sharing (CORS) configuration information set
for the bucket. To use this operation, you must have permission to perform the
s3:GetBucketCORS action. By default, the bucket owner has this permission and
can grant it to others. For more information about CORS, see Enabling
Cross-Origin Resource Sharing
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). The following
operations are related to GetBucketCors:
* PutBucketCors
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
*
DeleteBucketCors
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
Returns the default encryption configuration for an Amazon S3 bucket. If the
bucket does not have a default encryption configuration, GetBucketEncryption
returns ServerSideEncryptionConfigurationNotFoundError. For information about
the Amazon S3 default encryption feature, see Amazon S3 Default Bucket
Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html). To use
this operation, you must have permission to perform the
s3:GetEncryptionConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The following operations are related to GetBucketEncryption:
*
PutBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
*
DeleteBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
Gets the S3 Intelligent-Tiering configuration from the specified bucket. The S3
Intelligent-Tiering storage class is designed to optimize storage costs by
automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with
unknown, changing, or unpredictable access patterns, independent of object size
or retention period. If the size of an object is less than 128 KB, it is not
monitored and not eligible for auto-tiering. Smaller objects can be stored, but
they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class. For more information, see Storage class for
automatically optimizing frequently and infrequently accessed objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to GetBucketIntelligentTieringConfiguration include:
*
DeleteBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
PutBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
ListBucketIntelligentTieringConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
Returns an inventory configuration (identified by the inventory configuration
ID) from the bucket. To use this operation, you must have permissions to perform
the s3:GetInventoryConfiguration action. The bucket owner has this permission by
default and can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). The
following operations are related to GetBucketInventoryConfiguration:
*
DeleteBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
ListBucketInventoryConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
*
PutBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
Bucket lifecycle configuration now supports specifying a lifecycle rule using an
object key name prefix, one or more object tags, or a combination of both.
Accordingly, this section describes the latest API. The response describes the
new filter element that you can use to specify a filter to select a subset of
objects to which the rule applies. If you are using a previous version of the
lifecycle configuration, it still works. For the earlier action, see
GetBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html).
Returns the lifecycle configuration information set on the bucket. For
information about lifecycle configuration, see Object Lifecycle Management
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). To
use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration action. The bucket owner has this permission, by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
GetBucketLifecycleConfiguration has the following special error:
* Error code:
NoSuchLifecycleConfiguration
* Description: The lifecycle configuration does
not exist.
* HTTP Status Code: 404 Not Found
* SOAP Fault Code Prefix:
Client
The following operations are related to
GetBucketLifecycleConfiguration:
* GetBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)
*
PutBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)
*
DeleteBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
Returns the Region the bucket resides in. You set the bucket's Region using the
LocationConstraint request parameter in a CreateBucket request. For more
information, see CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). To use
this implementation of the operation, you must be the bucket owner. To use this
API against an access point, provide the alias of the access point in place of
the bucket name. The following operations are related to GetBucketLocation:
*
GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
Returns the logging status of a bucket and the permissions users have to view
and modify that status. To use GET, you must be the bucket owner. The following
operations are related to GetBucketLogging:
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
PutBucketLogging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html)
Gets a metrics configuration (specified by the metrics configuration ID) from
the bucket. Note that this doesn't include the daily storage metrics. To use
this operation, you must have permissions to perform the
s3:GetMetricsConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see Monitoring
Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to GetBucketMetricsConfiguration:
*
PutBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
DeleteBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
*
ListBucketMetricsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
*
Monitoring Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
Returns the notification configuration of a bucket. If notifications are not
enabled on the bucket, the action returns an empty NotificationConfiguration
element. By default, you must be the bucket owner to read the notification
configuration of a bucket. However, the bucket owner can use a bucket policy to
grant permission to other users to read this configuration with the
s3:GetBucketNotification permission. For more information about setting and
reading the notification configuration on a bucket, see Setting Up Notification
of Bucket Events
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). For
more information about bucket policies, see Using Bucket Policies
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The
following action is related to GetBucketNotification:
* PutBucketNotification
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html)
Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you
must have the s3:GetBucketOwnershipControls permission. For more information
about Amazon S3 permissions, see Specifying permissions in a policy
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see Using Object Ownership
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html).
The following operations are related to GetBucketOwnershipControls:
*
PutBucketOwnershipControls
* DeleteBucketOwnershipControls
Returns the policy of a specified bucket. If you are using an identity other
than the root user of the Amazon Web Services account that owns the bucket, the
calling identity must have the GetBucketPolicy permissions on the specified
bucket and belong to the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access
Denied error. If you have the correct permissions, but you're not using an
identity that belongs to the bucket owner's account, Amazon S3 returns a 405
Method Not Allowed error. As a security precaution, the root user of the Amazon
Web Services account that owns a bucket can always use this operation, even if
the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User
Policies
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The
following action is related to GetBucketPolicy:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the
bucket is public. In order to use this operation, you must have the
s3:GetBucketPolicyStatus permission. For more information about Amazon S3
permissions, see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
For more information about when Amazon S3 considers a bucket public, see The
Meaning of "Public"
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
The following operations are related to GetBucketPolicyStatus:
* Using Amazon
S3 Block Public Access
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
GetPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
PutPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
DeletePublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
Returns the replication configuration of a bucket. It can take a while to
propagate the put or delete a replication configuration to all Amazon S3
systems. Therefore, a get request soon after put or delete can return a wrong
result. For information about replication configuration, see Replication
(https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon
S3 User Guide. This action requires permissions for the
s3:GetReplicationConfiguration action. For more information about permissions,
see Using Bucket Policies and User Policies
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). If
you include the Filter element in a replication configuration, you must also
include the DeleteMarkerReplication and Priority elements. The response also
returns those elements. For information about GetBucketReplication errors, see
List of replication-related error codes
(https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
The following operations are related to GetBucketReplication:
*
PutBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
*
DeleteBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
Returns the request payment configuration of a bucket. To use this version of
the operation, you must be the bucket owner. For more information, see Requester
Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The
following operations are related to GetBucketRequestPayment:
* ListObjects
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
Returns the tag set associated with the bucket. To use this operation, you must
have permission to perform the s3:GetBucketTagging action. By default, the
bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
* Error code: NoSuchTagSet
*
Description: There is no tag set associated with the bucket.
The following
operations are related to GetBucketTagging:
* PutBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
*
DeleteBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
Returns the versioning state of a bucket. To retrieve the versioning state of a
bucket, you must be the bucket owner. This implementation also returns the MFA
Delete status of the versioning state. If the MFA Delete status is enabled, the
bucket owner must use an authentication device to change the versioning state of
the bucket. The following operations are related to GetBucketVersioning:
*
GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
Returns the website configuration for a bucket. To host website on Amazon S3,
you can configure a bucket as website by adding a website configuration. For
more information about hosting websites, see Hosting Websites on Amazon S3
(https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This GET
action requires the S3:GetBucketWebsite permission. By default, only the bucket
owner can read the bucket website configuration. However, bucket owners can
allow other users to read the website configuration by writing a bucket policy
granting them the S3:GetBucketWebsite permission. The following operations are
related to DeleteBucketWebsite:
* DeleteBucketWebsite
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html)
*
PutBucketWebsite
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
Retrieves objects from Amazon S3. To use GET, you must have READ access to the
object. If you grant READ access to the anonymous user, you can return the
object without using an authorization header. An Amazon S3 bucket has no
directory hierarchy such as you would find in a typical computer file system.
You can, however, create a logical hierarchy by using object key names that
imply a folder structure. For example, instead of naming an object sample.jpg,
you can name it photos/2006/February/sample.jpg. To get an object from such a
logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg, specify the resource as
/photos/2006/February/sample.jpg. For a path-style request example, if you have
the object photos/2006/February/sample.jpg in the bucket named examplebucket,
specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more
information about request types, see HTTP Host Header Bucket Specification
(https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket).
For more information about returning the ACL of an object, see GetObjectAcl
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html). If the
object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive
storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep
Archive tiers, before you can retrieve the object you must first restore a copy
using RestoreObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html).
Otherwise, this action returns an InvalidObjectStateError error. For information
about restoring archived objects, see Restoring Archived Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html).
Encryption request headers, like x-amz-server-side-encryption, should not be
sent for GET requests if your object uses server-side encryption with KMS keys
(SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys
(SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error. If you encrypt an object by using server-side encryption with
customer-provided encryption keys (SSE-C) when you store the object in Amazon
S3, then when you GET the object, you must use the following headers:
*
x-amz-server-side-encryption-customer-algorithm
*
x-amz-server-side-encryption-customer-key
*
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C,
see Server-Side Encryption (Using Customer-Provided Encryption Keys)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
Assuming you have the relevant permission to read object tags, the response also
returns the x-amz-tagging-count header that provides the count of number of tags
associated with the object. You can use GetObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) to
retrieve the tag set associated with an object. Permissions You need the
relevant read object (or version) permission for this operation. For more
information, see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If
the object you request does not exist, the error Amazon S3 returns depends on
whether you also have the s3:ListBucket permission.
* If you have the
s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status
code 404 ("no such key") error.
* If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 ("access denied")
error.
Versioning By default, the GET action returns the current version of an
object. To return a different version, use the versionId subresource.
* If you
supply a versionId, you need the s3:GetObjectVersion permission to access a
specific version of an object. If you request a specific version, you do not
need to have the s3:GetObject permission.
* If the current version of the
object is a delete marker, Amazon S3 behaves as if the object was deleted and
includes x-amz-delete-marker: true in the response.
For more information about
versioning, see PutBucketVersioning
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html).
Overriding Response Header Values There are times when you want to override
certain response header values in a GET response. For example, you might
override the Content-Disposition response header value in your GET request. You
can override values for a set of response headers using the following query
parameters. These response header values are sent only on a successful request,
that is, when status code 200 OK is returned. The set of headers you can
override using these parameters is a subset of the headers that Amazon S3
accepts when you create an object. The response headers that you can override
for the GET response are Content-Type, Content-Language, Expires, Cache-Control,
Content-Disposition, and Content-Encoding. To override these header values in
the GET response, you use the following request parameters. You must sign the
request, either using an Authorization header or a presigned URL, when using
these parameters. They cannot be used with an unsigned (anonymous) request.
*
response-content-type
* response-content-language
* response-expires
*
response-cache-control
* response-content-disposition
*
response-content-encoding
Additional Considerations about Request Headers If
both of the If-Match and If-Unmodified-Since headers are present in the request
as follows: If-Match condition evaluates to true, and; If-Unmodified-Since
condition evaluates to false; then, S3 returns 200 OK and the data requested. If
both of the If-None-Match and If-Modified-Since headers are present in the
request as follows: If-None-Match condition evaluates to false, and;
If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified
response code. For more information about conditional requests, see RFC 7232
(https://tools.ietf.org/html/rfc7232). The following operations are related to
GetObject:
* ListBuckets
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
*
GetObjectAcl
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
Returns the access control list (ACL) of an object. To use this operation, you
must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more
information, see Mapping of ACL permissions and access policy permissions
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping)
in the Amazon S3 User Guide This action is not supported by Amazon S3 on
Outposts. Versioning By default, GET returns ACL information about the current
version of an object. To return ACL information about a different version, use
the versionId subresource. If your bucket uses the bucket owner enforced setting
for S3 Object Ownership, requests to read ACLs are still supported and return
the bucket-owner-full-control ACL with the owner being the account that created
the bucket. For more information, see Controlling object ownership and
disabling ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. The following operations are related to
GetObjectAcl:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
*
PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
Retrieves all the metadata from an object without returning the object itself.
This action is useful if you're interested only in an object's metadata. To use
GetObjectAttributes, you must have READ access to the object.
GetObjectAttributes combines the functionality of GetObjectAcl,
GetObjectLegalHold, GetObjectLockConfiguration, GetObjectRetention,
GetObjectTagging, HeadObject, and ListParts. All of the data returned with each
of those individual calls can be returned with a single call to
GetObjectAttributes. If you encrypt an object by using server-side encryption
with customer-provided encryption keys (SSE-C) when you store the object in
Amazon S3, then when you retrieve the metadata from the object, you must use the
following headers:
* x-amz-server-side-encryption-customer-algorithm
*
x-amz-server-side-encryption-customer-key
*
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C,
see Server-Side Encryption (Using Customer-Provided Encryption Keys)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
* Encryption request headers, such as
x-amz-server-side-encryption, should not be sent for GET requests if your object
uses server-side encryption with Amazon Web Services KMS keys stored in Amazon
Web Services Key Management Service (SSE-KMS) or server-side encryption with
Amazon S3 managed encryption keys (SSE-S3). If your object does use these types
of keys, you'll get an HTTP 400 Bad Request error.
* The last modified property
in this case is the creation date of the object.
Consider the following when
using request headers:
* If both of the If-Match and If-Unmodified-Since
headers are present in the request as follows, then Amazon S3 returns the HTTP
status code 200 OK and the data requested:
* If-Match condition evaluates to
true.
* If-Unmodified-Since condition evaluates to false.
* If both of the
If-None-Match and If-Modified-Since headers are present in the request as
follows, then Amazon S3 returns the HTTP status code 304 Not Modified:
*
If-None-Match condition evaluates to false.
* If-Modified-Since condition
evaluates to true.
For more information about conditional requests, see RFC
7232 (https://tools.ietf.org/html/rfc7232). Permissions The permissions that you
need to use this operation depend on whether the bucket is versioned. If the
bucket is versioned, you need both the s3:GetObjectVersion and
s3:GetObjectVersionAttributes permissions for this operation. If the bucket is
not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions.
For more information, see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) in
the Amazon S3 User Guide. If the object that you request does not exist, the
error Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
* If you have the s3:ListBucket permission on the bucket, Amazon S3
returns an HTTP status code 404 Not Found ("no such key") error.
* If you don't
have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
Forbidden ("access denied") error.
The following actions are related to
GetObjectAttributes:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
GetObjectAcl
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
*
GetObjectLegalHold
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html)
*
GetObjectLockConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html)
*
GetObjectRetention
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html)
*
GetObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
*
HeadObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html)
*
ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
Gets an object's current legal hold status. For more information, see Locking
Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This
action is not supported by Amazon S3 on Outposts. The following action is
related to GetObjectLegalHold:
* GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
Gets the Object Lock configuration for a bucket. The rule specified in the
Object Lock configuration will be applied by default to every new object placed
in the specified bucket. For more information, see Locking Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). The
following action is related to GetObjectLockConfiguration:
*
GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
Retrieves an object's retention settings. For more information, see Locking
Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This
action is not supported by Amazon S3 on Outposts. The following action is
related to GetObjectRetention:
* GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
Returns the tag-set of an object. You send the GET request against the tagging
subresource associated with the object. To use this operation, you must have
permission to perform the s3:GetObjectTagging action. By default, the GET action
returns information about current version of an object. For a versioned bucket,
you can have multiple versions of an object in your bucket. To retrieve tags of
any other version, use the versionId query parameter. You also need permission
for the s3:GetObjectVersionTagging action. By default, the bucket owner has this
permission and can grant this permission to others. For information about the
Amazon S3 object tagging feature, see Object Tagging
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). The
following actions are related to GetObjectTagging:
* DeleteObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
*
GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
PutObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
Returns torrent files from a bucket. BitTorrent can save you bandwidth when
you're distributing large files. For more information about BitTorrent, see
Using BitTorrent with Amazon S3
(https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). You can get
torrent only for objects that are less than 5 GB in size, and that are not
encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object. This action is not
supported by Amazon S3 on Outposts. The following action is related to
GetObjectTorrent:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use
this operation, you must have the s3:GetBucketPublicAccessBlock permission. For
more information about Amazon S3 permissions, see Specifying Permissions in a
Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an
object, it checks the PublicAccessBlock configuration for both the bucket (or
the bucket that contains the object) and the bucket owner's account. If the
PublicAccessBlock settings are different between the bucket and the account,
Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings. For more information about when Amazon S3 considers a
bucket or an object public, see The Meaning of "Public"
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
The following operations are related to GetPublicAccessBlock:
* Using Amazon S3
Block Public Access
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
PutPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
GetPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
DeletePublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
This action is useful to determine if a bucket exists and you have permission to
access it. The action returns a 200 OK if the bucket exists and you have
permission to access it. If the bucket does not exist or you do not have
permission to access it, the HEAD request returns a generic 404 Not Found or 403
Forbidden code. A message body is not included, so you cannot determine the
exception beyond these error codes. To use this operation, you must have
permissions to perform the s3:ListBucket action. The bucket owner has this
permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
To use this API against an access point, you must provide the alias of the
access point in place of the bucket name or specify the access point ARN. When
using the access point ARN, 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 the
Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For
more information see, Using access points
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html).
The HEAD action retrieves metadata from an object without returning the object
itself. This action is useful if you're only interested in an object's metadata.
To use HEAD, you must have READ access to the object. A HEAD request has the
same options as a GET action on an object. The response is identical to the GET
response except that there is no response body. Because of this, if the HEAD
request generates an error, it returns a generic 404 Not Found or 403 Forbidden
code. It is not possible to retrieve the exact exception beyond these error
codes. If you encrypt an object by using server-side encryption with
customer-provided encryption keys (SSE-C) when you store the object in Amazon
S3, then when you retrieve the metadata from the object, you must use the
following headers:
* x-amz-server-side-encryption-customer-algorithm
*
x-amz-server-side-encryption-customer-key
*
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C,
see Server-Side Encryption (Using Customer-Provided Encryption Keys)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
*
Encryption request headers, like x-amz-server-side-encryption, should not be
sent for GET requests if your object uses server-side encryption with KMS keys
(SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys
(SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
* The last modified property in this case is the creation
date of the object.
Request headers are limited to 8 KB in size. For more
information, see Common Request Headers
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html).
Consider the following when using request headers:
* Consideration 1 – If both
of the If-Match and If-Unmodified-Since headers are present in the request as
follows:
* If-Match condition evaluates to true, and;
* If-Unmodified-Since
condition evaluates to false;
Then Amazon S3 returns 200 OK and the data
requested.
* Consideration 2 – If both of the If-None-Match and
If-Modified-Since headers are present in the request as follows:
*
If-None-Match condition evaluates to false, and;
* If-Modified-Since condition
evaluates to true;
Then Amazon S3 returns the 304 Not Modified response
code.
For more information about conditional requests, see RFC 7232
(https://tools.ietf.org/html/rfc7232). Permissions You need the relevant read
object (or version) permission for this operation. For more information, see
Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If
the object you request does not exist, the error Amazon S3 returns depends on
whether you also have the s3:ListBucket permission.
* If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code
404 ("no such key") error.
* If you don’t have the s3:ListBucket permission,
Amazon S3 returns an HTTP status code 403 ("access denied") error.
The
following actions are related to HeadObject:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
Lists the analytics configurations for the bucket. You can have up to 1,000
analytics configurations per bucket. This action supports list pagination and
does not return more than 100 configurations at a time. You should always check
the IsTruncated element in the response. If there are no more configurations to
list, IsTruncated is set to false. If there are more configurations to list,
IsTruncated is set to true, and there will be a value in NextContinuationToken.
You use the NextContinuationToken value to continue the pagination of the list
by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about Amazon S3 analytics feature, see Amazon S3 Analytics –
Storage Class Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
The following operations are related to ListBucketAnalyticsConfigurations:
*
GetBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
DeleteBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
PutBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
Lists the S3 Intelligent-Tiering configuration from the specified bucket. The S3
Intelligent-Tiering storage class is designed to optimize storage costs by
automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with
unknown, changing, or unpredictable access patterns, independent of object size
or retention period. If the size of an object is less than 128 KB, it is not
monitored and not eligible for auto-tiering. Smaller objects can be stored, but
they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class. For more information, see Storage class for
automatically optimizing frequently and infrequently accessed objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to ListBucketIntelligentTieringConfigurations include:
*
DeleteBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
PutBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
GetBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
Returns a list of inventory configurations for the bucket. You can have up to
1,000 analytics configurations per bucket. This action supports list pagination
and does not return more than 100 configurations at a time. Always check the
IsTruncated element in the response. If there are no more configurations to
list, IsTruncated is set to false. If there are more configurations to list,
IsTruncated is set to true, and there is a value in NextContinuationToken. You
use the NextContinuationToken value to continue the pagination of the list by
passing the value in continuation-token in the request to GET the next page. To
use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) The
following operations are related to ListBucketInventoryConfigurations:
*
GetBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
DeleteBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
PutBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
Lists the metrics configurations for the bucket. The metrics configurations are
only for the request metrics of the bucket and do not provide information on
daily storage metrics. You can have up to 1,000 configurations per bucket. This
action supports list pagination and does not return more than 100 configurations
at a time. Always check the IsTruncated element in the response. If there are no
more configurations to list, IsTruncated is set to false. If there are more
configurations to list, IsTruncated is set to true, and there is a value in
NextContinuationToken. You use the NextContinuationToken value to continue the
pagination of the list by passing the value in continuation-token in the request
to GET the next page. To use this operation, you must have permissions to
perform the s3:GetMetricsConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket
Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For more information about metrics configurations and CloudWatch request
metrics, see Monitoring Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to ListBucketMetricsConfigurations:
*
PutBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
GetBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
DeleteBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
Returns a list of all buckets owned by the authenticated sender of the request.
To use this operation, you must have the s3:ListAllMyBuckets permission.
This action lists in-progress multipart uploads. An in-progress multipart upload
is a multipart upload that has been initiated using the Initiate Multipart
Upload request, but has not yet been completed or aborted. This action returns
at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the
maximum number of uploads a response can include, which is also the default
value. You can further limit the number of uploads in a response by specifying
the max-uploads parameter in the response. If additional multipart uploads
satisfy the list criteria, the response will contain an IsTruncated element with
the value true. To list the additional multipart uploads, use the key-marker and
upload-id-marker request parameters. In the response, the uploads are sorted by
key. If your application has initiated more than one multipart upload using the
same object key, then uploads in the response are first sorted by key.
Additionally, uploads are sorted in ascending order within each key by the
upload initiation time. For more information on multipart uploads, see Uploading
Objects Using Multipart Upload
(https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For
information on permissions required to use the multipart upload API, see
Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The
following operations are related to ListMultipartUploads:
*
CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
Returns metadata about all versions of the objects in a bucket. You can also use
request parameters as selection criteria to return metadata about a subset of
all the object versions. To use this operation, you must have permissions to
perform the s3:ListBucketVersions action. Be aware of the name difference. A 200
OK response can contain valid or invalid XML. Make sure to design your
application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket. This action is
not supported by Amazon S3 on Outposts. The following operations are related to
ListObjectVersions:
* ListObjectsV2
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
*
GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the
request parameters as selection criteria to return a subset of the objects in a
bucket. A 200 OK response can contain valid or invalid XML. Be sure to design
your application to parse the contents of the response and handle it
appropriately. This action has been revised. We recommend that you use the newer
version, ListObjectsV2
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), when
developing applications. For backward compatibility, Amazon S3 continues to
support ListObjects. The following operations are related to ListObjects:
*
ListObjectsV2
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
*
GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
ListBuckets
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
Returns some or all (up to 1,000) of the objects in a bucket with each request.
You can use the request parameters as selection criteria to return a subset of
the objects in a bucket. A 200 OK response can contain valid or invalid XML.
Make sure to design your application to parse the contents of the response and
handle it appropriately. Objects are returned sorted in an ascending order of
the respective key names in the list. For more information about listing
objects, see Listing object keys programmatically
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)
To use this operation, you must have READ access to the bucket. To use this
action in an Identity and Access Management (IAM) policy, you must have
permissions to perform the s3:ListBucket action. The bucket owner has this
permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
This section describes the latest revision of this action. We recommend that you
use this revised API for application development. For backward compatibility,
Amazon S3 continues to support the prior version of this API, ListObjects
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html). To get a
list of your buckets, see ListBuckets
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html). The
following operations are related to ListObjectsV2:
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
Lists the parts that have been uploaded for a specific multipart upload. This
operation must include the upload ID, which you obtain by sending the initiate
multipart upload request (see CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)).
This request returns a maximum of 1,000 uploaded parts. The default number of
parts returned is 1,000 parts. You can restrict the number of parts returned by
specifying the max-parts request parameter. If your multipart upload consists of
more than 1,000 parts, the response returns an IsTruncated field with the value
of true, and a NextPartNumberMarker element. In subsequent ListParts requests
you can include the part-number-marker query string parameter and set its value
to the NextPartNumberMarker field value from the previous response. If the
upload was created using a checksum algorithm, you will need to have permission
to the kms:Decrypt action for the request to succeed. For more information on
multipart uploads, see Uploading Objects Using Multipart Upload
(https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For
information on permissions required to use the multipart upload API, see
Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The
following operations are related to ListParts:
* CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
GetObjectAttributes
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer
Acceleration is a bucket-level feature that enables you to perform faster data
transfers to Amazon S3. To use this operation, you must have permission to
perform the s3:PutAccelerateConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket
Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The Transfer Acceleration state of a bucket can be set to one of the following
two values:
* Enabled – Enables accelerated data transfers to the bucket.
*
Suspended – Disables accelerated data transfers to the bucket.
The
GetBucketAccelerateConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html)
action returns the transfer acceleration state of a bucket. After setting the
Transfer Acceleration state of a bucket to Enabled, it might take up to thirty
minutes before the data transfer rates to the bucket increase. The name of the
bucket used for Transfer Acceleration must be DNS-compliant and must not contain
periods ("."). For more information about transfer acceleration, see Transfer
Acceleration
(https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
The following operations are related to PutBucketAccelerateConfiguration:
*
GetBucketAccelerateConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html)
*
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
Sets the permissions on an existing bucket using access control lists (ACL). For
more information, see Using ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To set
the ACL of a bucket, you must have WRITE_ACP permission. You can use one of the
following two ways to set a bucket's permissions:
* Specify the ACL in the
request body
* Specify permissions using request headers
You cannot specify
access permission using both the body and the request headers. Depending on your
application needs, you may choose to set the ACL on a bucket using either the
request body or the headers. For example, if you have an existing application
that updates a bucket ACL using the request body, then you can continue to use
that approach. If your bucket uses the bucket owner enforced setting for S3
Object Ownership, ACLs are disabled and no longer affect permissions. You must
use policies to grant access to your bucket and the objects in it. Requests to
set ACLs or update ACLs fail and return the AccessControlListNotSupported error
code. Requests to read ACLs are still supported. For more information, see
Controlling object ownership
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. Access Permissions You can set access permissions
using one of the following methods:
* Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify
the canned ACL name as the value of x-amz-acl. If you use this header, you
cannot use other access control-specific headers in your request. For more
information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*
Specify access permissions explicitly with the x-amz-grant-read,
x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and
grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use the x-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that
Amazon S3 supports in an ACL. For more information, see Access Control List
(ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify
each grantee as a type=value pair, where the type is one of the following:
* id
– if the value specified is the canonical user ID of an Amazon Web Services
account
* uri – if you are granting permissions to a predefined group
*
emailAddress – if the value specified is the email address of an Amazon Web
Services account 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
For example, the following
x-amz-grant-write header grants create, overwrite, and delete objects permission
to LogDelivery group predefined by Amazon S3 and two Amazon Web Services
accounts identified by their email addresses. x-amz-grant-write:
uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333",
id="555566667777"
You can use either a canned ACL or specify access permissions
explicitly. You cannot do both. Grantee Values You can specify the person
(grantee) to whom you're assigning access rights (using request elements) in the
following ways:
* By the person's ID: <>ID<><>GranteesEmail<> DisplayName is
optional and ignored in the request
* By URI:
<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>
* By Email
address: <>Grantees@email.com<>lt;/Grantee> The grantee is resolved to the
CanonicalUser and, in a response to a GET Object acl request, appears as the
CanonicalUser. 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
# Related Resources
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
DeleteBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
GetObjectAcl
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
Sets an analytics configuration for the bucket (specified by the analytics
configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a
comma-separated values (CSV) flat file. See the DataExport request element.
Reports are updated daily and are based on the object filters that you
configure. When selecting data export, you specify a destination bucket and an
optional destination prefix where the file is written. You can export the data
to a destination bucket in a different account. However, the destination bucket
must be in the same Region as the bucket that you are making the PUT analytics
configuration to. For more information, see Amazon S3 Analytics – Storage Class
Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
You must create a bucket policy on the destination bucket where the exported
file is written to grant permissions to Amazon S3 to write objects to the
bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory
and Storage Class Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
Special Errors
* HTTP Error: HTTP 400 Bad Request
* Code: InvalidArgument
*
Cause: Invalid argument.
* HTTP Error: HTTP 400 Bad Request
* Code:
TooManyConfigurations
* Cause: You are attempting to create a new configuration
but have already reached the 1,000-configuration limit.
* HTTP Error: HTTP 403
Forbidden
* Code: AccessDenied
* Cause: You are not the owner of the specified
bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to
set the configuration on the bucket.
# Related Resources
*
GetBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
DeleteBucketAnalyticsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
ListBucketAnalyticsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
Sets the cors configuration for your bucket. If the configuration exists, Amazon
S3 replaces it. To use this operation, you must be allowed to perform the
s3:PutBucketCORS action. By default, the bucket owner has this permission and
can grant it to others. You set this configuration on a bucket so that the
bucket can service cross-origin requests. For example, you might want to enable
a request whose origin is http://www.example.com to access your Amazon S3 bucket
at my.example.bucket.com by using the browser's XMLHttpRequest capability. To
enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the bucket. The cors subresource is an XML document in which you
configure rules that identify origins and the HTTP methods that can be executed
on your bucket. The document is limited to 64 KB in size. When Amazon S3
receives a cross-origin request (or a pre-flight OPTIONS request) against a
bucket, it evaluates the cors configuration on the bucket and uses the first
CORSRule rule that matches the incoming browser request to enable a cross-origin
request. For a rule to match, the following conditions must be met:
* The
request's Origin header must match AllowedOrigin elements.
* The request method
(for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
header in case of a pre-flight OPTIONS request must be one of the AllowedMethod
elements.
* Every header specified in the Access-Control-Request-Headers
request header of a pre-flight request must match an AllowedHeader element.
For
more information about CORS, go to Enabling Cross-Origin Resource Sharing
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3
User Guide. Related Resources
* GetBucketCors
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html)
*
DeleteBucketCors
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
*
RESTOPTIONSobject
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
This action uses the encryption subresource to configure default encryption and
Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can
use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer
managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can
also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if
you upload an object to the bucket and do not specify the KMS key to use for
encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for
your account. For information about default encryption, see Amazon S3 default
bucket encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the
Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3
Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in
the Amazon S3 User Guide. This action requires Amazon Web Services Signature
Version 4. For more information, see Authenticating Requests (Amazon Web
Services Signature Version 4)
(https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. Related Resources
* GetBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
*
DeleteBucketEncryption
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can
have up to 1,000 S3 Intelligent-Tiering configurations per bucket. The S3
Intelligent-Tiering storage class is designed to optimize storage costs by
automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with
unknown, changing, or unpredictable access patterns, independent of object size
or retention period. If the size of an object is less than 128 KB, it is not
monitored and not eligible for auto-tiering. Smaller objects can be stored, but
they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class. For more information, see Storage class for
automatically optimizing frequently and infrequently accessed objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to PutBucketIntelligentTieringConfiguration include:
*
DeleteBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
GetBucketIntelligentTieringConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
*
ListBucketIntelligentTieringConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
You
only need S3 Intelligent-Tiering enabled on a bucket if you want to
automatically move objects stored in the S3 Intelligent-Tiering storage class to
the Archive Access or Deep Archive Access tier. Special Errors
* HTTP 400 Bad
Request Error
* Code: InvalidArgument
* Cause: Invalid Argument
* HTTP 400
Bad Request Error
* Code: TooManyConfigurations
* Cause: You are attempting to
create a new configuration but have already reached the 1,000-configuration
limit.
* HTTP 403 Forbidden Error
* Code: AccessDenied
* Cause: You are not
the owner of the specified bucket, or you do not have the
s3:PutIntelligentTieringConfiguration bucket permission to set the configuration
on the bucket.
This implementation of the PUT action adds an inventory configuration
(identified by the inventory ID) to the bucket. You can have up to 1,000
inventory configurations per bucket. Amazon S3 inventory generates inventories
of the objects in the bucket on a daily or weekly basis, and the results are
published to a flat file. The bucket that is inventoried is called the source
bucket, and the bucket where the inventory flat file is stored is called the
destination bucket. The destination bucket must be in the same Amazon Web
Services Region as the source bucket. When you configure an inventory for a
source bucket, you specify the destination bucket where you want the inventory
to be stored, and whether to generate the inventory daily or weekly. You can
also configure what object metadata to include and whether to inventory all
object versions or only current versions. For more information, see Amazon S3
Inventory
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) in the
Amazon S3 User Guide. You must create a bucket policy on the destination bucket
to grant permissions to Amazon S3 to write objects to the bucket in the defined
location. For an example policy, see Granting Permissions for Amazon S3
Inventory and Storage Class Analysis
(https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration action. The bucket owner has this permission by
default and can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. Special Errors
* HTTP 400 Bad Request Error
*
Code: InvalidArgument
* Cause: Invalid Argument
* HTTP 400 Bad Request
Error
* Code: TooManyConfigurations
* Cause: You are attempting to create a
new configuration but have already reached the 1,000-configuration limit.
*
HTTP 403 Forbidden Error
* Code: AccessDenied
* Cause: You are not the owner
of the specified bucket, or you do not have the s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
# Related Resources
*
GetBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
DeleteBucketInventoryConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
ListBucketInventoryConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
Creates a new lifecycle configuration for the bucket or replaces an existing
lifecycle configuration. Keep in mind that this will overwrite an existing
lifecycle configuration, so if you want to retain any configuration details,
they must be included in the new lifecycle configuration. For information about
lifecycle configuration, see Managing your storage lifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html).
Bucket lifecycle configuration now supports specifying a lifecycle rule using an
object key name prefix, one or more object tags, or a combination of both.
Accordingly, this section describes the latest API. The previous version of the
API supported filtering based only on an object key name prefix, which is
supported for backward compatibility. For the related API description, see
PutBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).
Rules You specify the lifecycle configuration in your request body. The
lifecycle configuration is specified as XML consisting of one or more rules. An
Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not
adjustable. Each rule consists of the following:
* Filter identifying a subset
of objects to which the rule applies. The filter can be based on a key name
prefix, object tags, or a combination of both.
* Status whether the rule is in
effect.
* One or more lifecycle transition and expiration actions that you want
Amazon S3 to perform on the objects identified by the filter. If the state of
your bucket is versioning-enabled or versioning-suspended, you can have many
versions of the same object (one current version and zero or more noncurrent
versions). Amazon S3 provides predefined actions that you can specify for
current and noncurrent object versions.
For more information, see Object
Lifecycle Management
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) and
Lifecycle Configuration Elements
(https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html).
Permissions By default, all Amazon S3 resources are private, including buckets,
objects, and related subresources (for example, lifecycle configuration and
website configuration). Only the resource owner (that is, the Amazon Web
Services account that created it) can access the resource. The resource owner
can optionally grant access permissions to others by writing an access policy.
For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any
other permissions. If you want to block users or accounts from removing or
deleting objects from your bucket, you must deny them permissions for the
following actions:
* s3:DeleteObject
* s3:DeleteObjectVersion
*
s3:PutLifecycleConfiguration
For more information about permissions, see
Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The following are related to PutBucketLifecycleConfiguration:
* Examples of
Lifecycle Configuration
(https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html)
*
GetBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
*
DeleteBucketLifecycle
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
Set the logging parameters for a bucket and to specify permissions for who can
view and modify the logging parameters. All logs are saved to buckets in the
same Amazon Web Services Region as the source bucket. To set the logging status
of a bucket, you must be the bucket owner. The bucket owner is automatically
granted FULL_CONTROL to all logs. You use the Grantee request element to grant
access to other people. The Permissions request element specifies the kind of
access the grantee has to the logs. If the target bucket for log delivery uses
the bucket owner enforced setting for S3 Object Ownership, you can't use the
Grantee request element to grant access to others. Permissions can only be
granted using policies. For more information, see Permissions for server access
log delivery
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general)
in the Amazon S3 User Guide. Grantee Values You can specify the person (grantee)
to whom you're assigning access rights (using request elements) in the following
ways:
* By the person's ID: <>ID<><>GranteesEmail<> DisplayName is optional
and ignored in the request.
* By Email address: <>Grantees@email.com<> The
grantee is resolved to the CanonicalUser and, in a response to a GET Object acl
request, appears as the CanonicalUser.
* By URI:
<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>
To enable
logging, you use LoggingEnabled and its children request elements. To disable
logging, you use an empty BucketLoggingStatus request element: For more
information about server access logging, see Server Access Logging
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html) in the
Amazon S3 User Guide. For more information about creating a bucket, see
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). For
more information about returning the logging status of a bucket, see
GetBucketLogging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html). The
following operations are related to PutBucketLogging:
* PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
DeleteBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
GetBucketLogging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html)
Sets a metrics configuration (specified by the metrics configuration ID) for the
bucket. You can have up to 1,000 metrics configurations per bucket. If you're
updating an existing metrics configuration, note that this is a full replacement
of the existing metrics configuration. If you don't include the elements you
want to keep, they are erased. To use this operation, you must have permissions
to perform the s3:PutMetricsConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket
Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see Monitoring
Metrics with Amazon CloudWatch
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to PutBucketMetricsConfiguration:
*
DeleteBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
*
GetBucketMetricsConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
ListBucketMetricsConfigurations
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
GetBucketLifecycle
has the following special error:
* Error code: TooManyConfigurations
*
Description: You are attempting to create a new configuration but have already
reached the 1,000-configuration limit.
* HTTP Status Code: HTTP 400 Bad Request
Enables notifications of specified events for a bucket. For more information
about event notifications, see Configuring Event Notifications
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). Using
this API, you can replace an existing notification configuration. The
configuration is an XML file that defines the event types that you want Amazon
S3 to publish and the destination where you want Amazon S3 to publish an event
notification when it detects an event of the specified type. By default, your
bucket has no event notifications configured. That is, the notification
configuration will be an empty NotificationConfiguration. This action replaces
the existing notification configuration with the configuration you include in
the request body. After Amazon S3 receives this request, it first verifies that
any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
Service (Amazon SQS) destination exists, and that the bucket owner has
permission to publish to it by sending a test notification. In the case of
Lambda destinations, Amazon S3 verifies that the Lambda function permissions
grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For
more information, see Configuring Notifications for Amazon S3 Events
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). You
can disable notifications by adding the empty NotificationConfiguration element.
For more information about the number of event notification configurations that
you can create per bucket, see Amazon S3 service quotas
(https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3) in Amazon Web
Services General Reference. By default, only the bucket owner can configure
notifications on a bucket. However, bucket owners can use a bucket policy to
grant permission to other users to set this configuration with
s3:PutBucketNotification permission. The PUT notification is an atomic
operation. For example, suppose your notification configuration includes SNS
topic, SQS queue, and Lambda function configurations. When you send a PUT
request with this configuration, Amazon S3 sends test messages to your SNS
topic. If the message fails, the entire PUT action will fail, and Amazon S3 will
not add the configuration to your bucket. Responses If the configuration in the
request body includes only one TopicConfiguration specifying only the
s3:ReducedRedundancyLostObject event type, the response will also include the
x-amz-sns-test-message-id header containing the message ID of the test
notification sent to the topic. The following action is related to
PutBucketNotificationConfiguration:
* GetBucketNotificationConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this
operation, you must have the s3:PutBucketOwnershipControls permission. For more
information about Amazon S3 permissions, see Specifying permissions in a policy
(https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see Using object ownership
(https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html).
The following operations are related to PutBucketOwnershipControls:
*
GetBucketOwnershipControls
* DeleteBucketOwnershipControls
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an
identity other than the root user of the Amazon Web Services account that owns
the bucket, the calling identity must have the PutBucketPolicy permissions on
the specified bucket and belong to the bucket owner's account in order to use
this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns
a 403 Access Denied error. If you have the correct permissions, but you're not
using an identity that belongs to the bucket owner's account, Amazon S3 returns
a 405 Method Not Allowed error. As a security precaution, the root user of the
Amazon Web Services account that owns a bucket can always use this operation,
even if the policy explicitly denies the root user the ability to perform this
action. For more information, see Bucket policy examples
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).
The following operations are related to PutBucketPolicy:
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
DeleteBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Creates a replication configuration or replaces an existing one. For more
information, see Replication
(https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon
S3 User Guide. Specify the replication configuration in the request body. In the
replication configuration, you provide the name of the destination bucket or
buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon
S3 can assume to replicate objects on your behalf, and other relevant
information. A replication configuration must include at least one rule, and can
contain a maximum of 1,000. Each rule identifies a subset of objects to
replicate by filtering the objects in the source bucket. To choose additional
subsets of objects to replicate, add a rule for each subset. To specify a subset
of the objects in the source bucket to apply a replication rule to, add the
Filter element as a child of the Rule element. You can filter objects based on
an object key prefix, one or more object tags, or both. When you add the Filter
element in the configuration, you must also add the following elements:
DeleteMarkerReplication, Status, and Priority. If you are using an earlier
version of the replication configuration, Amazon S3 handles replication of
delete markers differently. For more information, see Backward Compatibility
(https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
For information about enabling versioning on a bucket, see Using Versioning
(https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). Handling
Replication of Encrypted Objects By default, Amazon S3 doesn't replicate objects
that are stored at rest using server-side encryption with KMS keys. To replicate
Amazon Web Services KMS-encrypted objects, add the following:
SourceSelectionCriteria, SseKmsEncryptedObjects, Status,
EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication
configuration, see Replicating Objects Created with SSE Using KMS keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html).
For information on PutBucketReplication errors, see List of replication-related
error codes
(https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
Permissions To create a PutBucketReplication request, you must have
s3:PutReplicationConfiguration permissions for the bucket. By default, a
resource owner, in this case the Amazon Web Services account that created the
bucket, can perform this operation. The resource owner can also grant others
permissions to perform the operation. For more information about permissions,
see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) and
Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
To perform this operation, the user or role performing the action must have the
iam:PassRole
(https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html)
permission. The following operations are related to PutBucketReplication:
*
GetBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
*
DeleteBucketReplication
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
Sets the request payment configuration for a bucket. By default, the bucket
owner pays for downloads from the bucket. This configuration parameter enables
the bucket owner (only) to specify that the person requesting the download will
be charged for the download. For more information, see Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The
following operations are related to PutBucketRequestPayment:
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
GetBucketRequestPayment
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html)
Sets the tags for a bucket. Use tags to organize your Amazon Web Services bill
to reflect your own cost structure. To do this, sign up to get your Amazon Web
Services account bill with tag key values included. Then, to see the cost of
combined resources, organize your billing information according to resources
with the same tag key values. For example, you can tag several resources with a
specific application name, and then organize your billing information to see the
total cost of that application across several services. For more information,
see Cost Allocation and Tagging
(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
and Using Cost Allocation in Amazon S3 Bucket Tags
(https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html). When
this operation sets the tags for a bucket, it will overwrite any current tags
the bucket already has. You cannot use this operation to add tags to an existing
list of tags. To use this operation, you must have permissions to perform the
s3:PutBucketTagging action. The bucket owner has this permission by default and
can grant this permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
PutBucketTagging has the following special errors:
* Error code:
InvalidTagError
* Description: The tag provided was not a valid tag. This error
can occur if the tag did not pass input validation. For information about tag
restrictions, see User-Defined Tag Restrictions
(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)
and Amazon Web Services-Generated Cost Allocation Tag Restrictions
(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html).
*
Error code: MalformedXMLError
* Description: The XML provided does not match
the schema.
* Error code: OperationAbortedError
* Description: A conflicting
conditional action is currently in progress against this resource. Please try
again.
* Error code: InternalError
* Description: The service was unable to
apply the provided tag to the bucket.
The following operations are related to
PutBucketTagging:
* GetBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
*
DeleteBucketTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
Sets the versioning state of an existing bucket. You can set the versioning
state with one of the following values: Enabled—Enables versioning for the
objects in the bucket. All objects added to the bucket receive a unique version
ID. Suspended—Disables versioning for the objects in the bucket. All objects
added to the bucket receive the version ID null. If the versioning state has
never been set on a bucket, it has no versioning state; a GetBucketVersioning
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html)
request does not return a versioning state value. In order to enable MFA Delete,
you must be the bucket owner. If you are the bucket owner and want to enable MFA
Delete in the bucket versioning configuration, you must include the x-amz-mfa
request header and the Status and the MfaDelete request elements in a request to
set the versioning state of the bucket. If you have an object expiration
lifecycle policy in your non-versioned bucket and you want to maintain the same
permanent delete behavior when you enable versioning, you must add a noncurrent
expiration policy. The noncurrent expiration lifecycle policy will manage the
deletes of the noncurrent object versions in the version-enabled bucket. (A
version-enabled bucket maintains one current and zero or more noncurrent object
versions.) For more information, see Lifecycle and Versioning
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config).
Related Resources
* CreateBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
DeleteBucket
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
GetBucketVersioning
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html)
Sets the configuration of the website that is specified in the website
subresource. To configure a bucket as a website, you can add this subresource on
the bucket with website configuration information such as the file name of the
index document and any redirect rules. For more information, see Hosting
Websites on Amazon S3
(https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This PUT
action requires the S3:PutBucketWebsite permission. By default, only the bucket
owner can configure the website attached to a bucket; however, bucket owners can
allow other users to set the website configuration by writing a bucket policy
that grants them the S3:PutBucketWebsite permission. To redirect all website
requests sent to the bucket's website endpoint, you add a website configuration
with the following elements. Because all requests are sent to another website,
you don't need to provide index document name for the bucket.
*
WebsiteConfiguration
* RedirectAllRequestsTo
* HostName
* Protocol
If you
want granular control over redirects, you can use the following elements to add
routing rules that describe conditions for redirecting requests and information
about the redirect destination. In this case, the website configuration must
provide an index document for the bucket, because some requests might not be
redirected.
* WebsiteConfiguration
* IndexDocument
* Suffix
*
ErrorDocument
* Key
* RoutingRules
* RoutingRule
* Condition
*
HttpErrorCodeReturnedEquals
* KeyPrefixEquals
* Redirect
* Protocol
*
HostName
* ReplaceKeyPrefixWith
* ReplaceKeyWith
* HttpRedirectCode
Amazon
S3 has a limitation of 50 routing rules per website configuration. If you
require more than 50 routing rules, you can use object redirect. For more
information, see Configuring an Object Redirect
(https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in
the Amazon S3 User Guide.
Adds an object to a bucket. You must have WRITE permissions on a bucket to add
an object to it. Amazon S3 never adds partial objects; if you receive a success
response, Amazon S3 added the entire object to the bucket. Amazon S3 is a
distributed system. If it receives multiple write requests for the same object
simultaneously, it overwrites all but the last object written. Amazon S3 does
not provide object locking; if you need this, make sure to build it into your
application layer or use versioning instead. To ensure that data is not
corrupted traversing the network, use the Content-MD5 header. When you use this
header, Amazon S3 checks the object against the provided MD5 value and, if they
do not match, returns an error. Additionally, you can calculate the MD5 while
putting an object to Amazon S3 and compare the returned ETag to the calculated
MD5 value.
* To successfully complete the PutObject request, you must have the
s3:PutObject in your IAM permissions.
* To successfully change the objects acl
of your PutObject request, you must have the s3:PutObjectAcl in your IAM
permissions.
* The Content-MD5 header is required for any request to upload an
object with a retention period configured using Amazon S3 Object Lock. For more
information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in
the Amazon S3 User Guide.
Server-side Encryption You can optionally request
server-side encryption. With server-side encryption, Amazon S3 encrypts your
data as it writes it to disks in its data centers and decrypts the data when you
access it. You have the option to provide your own encryption key or use Amazon
Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information,
see Using Server-Side Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html).
If you request server-side encryption using Amazon Web Services Key Management
Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more
information, see Amazon S3 Bucket Keys
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the Amazon
S3 User Guide. Access Control List (ACL)-Specific Request Headers You can use
headers to grant ACL- based permissions. By default, all objects are private.
Only the owner has full access control. When adding a new object, you can grant
permissions to individual Amazon Web Services accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the ACL on the object.
For more information, see Access Control List (ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing
ACLs Using the REST API
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). If
the bucket that you're uploading objects to uses the bucket owner enforced
setting for S3 Object Ownership, ACLs are disabled and no longer affect
permissions. Buckets that use this setting only accept PUT requests that don't
specify an ACL or PUT requests that specify bucket owner full control ACLs, such
as the bucket-owner-full-control canned ACL or an equivalent form of this ACL
expressed in the XML format. PUT requests that contain other ACLs (for example,
custom grants to certain Amazon Web Services accounts) fail and return a 400
error with the error code AccessControlListNotSupported. For more information,
see Controlling ownership of objects and disabling ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced
setting for Object Ownership, all objects written to the bucket by any account
will be owned by the bucket owner. Storage Class Options 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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in
the Amazon S3 User Guide. Versioning If you enable versioning for a bucket,
Amazon S3 automatically generates a unique version ID for the object being
stored. Amazon S3 returns this ID in the response. When you enable versioning
for a bucket, if Amazon S3 receives multiple write requests for the same object
simultaneously, it stores all of the objects. For more information about
versioning, see Adding Objects to Versioning Enabled Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html).
For information about returning the versioning state of a bucket, see
GetBucketVersioning
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html).
Related Resources
* CopyObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
*
DeleteObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
Uses the acl subresource to set the access control list (ACL) permissions for a
new or existing object in an S3 bucket. You must have WRITE_ACP permission to
set the ACL of an object. For more information, see What permissions can I
grant?
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions)
in the Amazon S3 User Guide. This action is not supported by Amazon S3 on
Outposts. Depending on your application needs, you can choose to set the ACL on
an object using either the request body or the headers. For example, if you have
an existing application that updates a bucket ACL using the request body, you
can continue to use that approach. For more information, see Access Control List
(ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the
Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for
S3 Object Ownership, ACLs are disabled and no longer affect permissions. You
must use policies to grant access to your bucket and the objects in it. Requests
to set ACLs or update ACLs fail and return the AccessControlListNotSupported
error code. Requests to read ACLs are still supported. For more information, see
Controlling object ownership
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the Amazon S3 User Guide. Access Permissions You can set access permissions
using one of the following methods:
* Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify
the canned ACL name as the value of x-amz-acl. If you use this header, you
cannot use other access control-specific headers in your request. For more
information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*
Specify access permissions explicitly with the x-amz-grant-read,
x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and
grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use x-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that
Amazon S3 supports in an ACL. For more information, see Access Control List
(ACL) Overview
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify
each grantee as a type=value pair, where the type is one of the following:
* id
– if the value specified is the canonical user ID of an Amazon Web Services
account
* uri – if you are granting permissions to a predefined group
*
emailAddress – if the value specified is the email address of an Amazon Web
Services account 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
For example, the following
x-amz-grant-read header grants list objects permission to the two Amazon Web
Services accounts identified by their email addresses. x-amz-grant-read:
emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"
You can use either
a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values You can specify the person (grantee) to whom you're assigning
access rights (using request elements) in the following ways:
* By the person's
ID: <>ID<><>GranteesEmail<> DisplayName is optional and ignored in the
request.
* By URI:
<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>
* By Email
address: <>Grantees@email.com<>lt;/Grantee> The grantee is resolved to the
CanonicalUser and, in a response to a GET Object acl request, appears as the
CanonicalUser. 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
(https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the
Amazon Web Services General Reference.
Versioning The ACL of an object is set
at the object version level. By default, PUT sets the ACL of the current version
of an object. To set the ACL of a different version, use the versionId
subresource. Related Resources
* CopyObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
*
GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
Applies a legal hold configuration to the specified object. For more
information, see Locking Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action
is not supported by Amazon S3 on Outposts.
Places an Object Lock configuration on the specified bucket. The rule specified
in the Object Lock configuration will be applied by default to every new object
placed in the specified bucket. For more information, see Locking Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
* The
DefaultRetention settings require both a mode and a period.
* The
DefaultRetention period can be either Days or Years but you must select one. You
cannot specify Days and Years at the same time.
* You can only enable Object
Lock for new buckets. If you want to turn on Object Lock for an existing bucket,
contact Amazon Web Services Support.
Places an Object Retention configuration on an object. For more information, see
Locking Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). Users or
accounts require the s3:PutObjectRetention permission in order to place an
Object Retention configuration on objects. Bypassing a Governance Retention
configuration requires the s3:BypassGovernanceRetention permission. This action
is not supported by Amazon S3 on Outposts.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is
a key-value pair. You can associate tags with an object by sending a PUT request
against the tagging subresource that is associated with the object. You can
retrieve tags by sending a GET request. For more information, see
GetObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). For
tagging-related restrictions related to characters and encodings, see Tag
Restrictions
(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html).
Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To
use this operation, you must have permission to perform the s3:PutObjectTagging
action. By default, the bucket owner has this permission and can grant this
permission to others. To put tags of any other version, use the versionId query
parameter. You also need permission for the s3:PutObjectVersionTagging action.
For information about the Amazon S3 object tagging feature, see Object Tagging
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). Special
Errors
* Code: InvalidTagError
* Cause: The tag provided was not a valid tag.
This error can occur if the tag did not pass input validation. For more
information, see Object Tagging
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
* Code:
MalformedXMLError
* Cause: The XML provided does not match the schema.
* Code:
OperationAbortedError
* Cause: A conflicting conditional action is currently in
progress against this resource. Please try again.
* Code: InternalError
*
Cause: The service was unable to apply the provided tag to the object.
Related
Resources
* GetObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
*
DeleteObjectTagging
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.
To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying
Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an
object, it checks the PublicAccessBlock configuration for both the bucket (or
the bucket that contains the object) and the bucket owner's account. If the
PublicAccessBlock configurations are different between the bucket and the
account, Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings. For more information about when Amazon S3 considers a
bucket or an object public, see The Meaning of "Public"
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
Related Resources
* GetPublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
DeletePublicAccessBlock
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
*
GetBucketPolicyStatus
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
*
Using Amazon S3 Block Public Access
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
Restores an archived copy of an object back into Amazon S3 This action is not
supported by Amazon S3 on Outposts. This action performs the following types of
requests:
* select - Perform a select query on an archived object
* restore an
archive - Restore an archived object
To use this operation, you must have
permissions to perform the s3:RestoreObject action. The bucket owner has this
permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource
Operations
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and Managing Access Permissions to Your Amazon S3 Resources
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the Amazon S3 User Guide. Querying Archives with Select Requests You use a
select type of request to perform SQL queries on archived objects. The archived
objects that are being queried by the select request must be formatted as
uncompressed comma-separated values (CSV) files. You can run queries and custom
analytics on your archived data without having to restore your data to a hotter
Amazon S3 tier. For an overview about select requests, see Querying Archived
Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html)
in the Amazon S3 User Guide. When making a select request, do the following:
*
Define an output location for the select query's output. This must be an Amazon
S3 bucket in the same Amazon Web Services Region as the bucket that contains the
archive object that is being queried. The Amazon Web Services account that
initiates the job must have permissions to write to the S3 bucket. You can
specify the storage class and encryption for the output objects stored in the
bucket. For more information about output, see Querying Archived Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html)
in the Amazon S3 User Guide. For more information about the S3 structure in the
request body, see the following:
* PutObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
* Managing
Access with ACLs
(https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) in the
Amazon S3 User Guide
* Protecting Data Using Server-Side Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in
the Amazon S3 User Guide
* Define the SQL expression for the SELECT type of
restoration for your query in the request body's SelectParameters structure. You
can use expressions like the following examples.
* The following expression
returns all records from the specified object. SELECT * FROM Object
* Assuming
that you are not using any headers for data stored in the object, you can
specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE
s._3 > 100
* If you have headers and you set the fileHeaderInfo in the CSV
structure in the request body to USE, you can specify headers in the query. (If
you set the fileHeaderInfo field to IGNORE, the first row is skipped for the
query.) You cannot mix ordinal positions with header column names. SELECT s.Id,
s.FirstName, s.SSN FROM S3Object s
For more information about using SQL with S3
Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier
Select
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
in the Amazon S3 User Guide. When making a select request, you can also do the
following:
* To expedite your queries, specify the Expedited tier. For more
information about tiers, see "Restoring Archives," later in this topic.
*
Specify details about the data serialization format of both the input object
that is being queried and the serialization of the CSV-encoded query
results.
The following are additional important facts about the select
feature:
* The output results are new Amazon S3 objects. Unlike archive
retrievals, they are stored until explicitly deleted-manually or through a
lifecycle policy.
* You can issue more than one select request on the same
Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing
duplicate requests.
* Amazon S3 accepts a select request even if the object has
already been restored. A select request doesn’t return error response
409.
Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier
Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3
Intelligent-Tiering Deep Archive tiers are not accessible in real time. For
objects in Archive Access or Deep Archive Access tiers you must first initiate a
restore request, and then wait until the object is moved into the Frequent
Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage
classes you must first initiate a restore request, and then wait until a
temporary copy of the object is available. To access an archived object, you
must restore the object for the duration (number of days) that you specify. To
restore a specific object version, you can provide a version ID. If you don't
provide a version ID, Amazon S3 restores the current version. When restoring an
archived object (or using a select request), you can specify one of the
following data access tier options in the Tier element of the request body:
*
Expedited - Expedited retrievals allow you to quickly access your data stored in
the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when
occasional urgent requests for a subset of archives are required. For all but
the largest archived objects (250 MB+), data accessed using Expedited retrievals
is typically made available within 1–5 minutes. Provisioned capacity ensures
that retrieval capacity for Expedited retrievals is available when you need it.
Expedited retrievals and provisioned capacity are not available for objects
stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
Deep Archive tier.
* Standard - Standard retrievals allow you to access any of
your archived objects within several hours. This is the default option for
retrieval requests that do not specify the retrieval option. Standard retrievals
typically finish within 3–5 hours for objects stored in the S3 Glacier storage
class or S3 Intelligent-Tiering Archive tier. They typically finish within 12
hours for objects stored in the S3 Glacier Deep Archive storage class or S3
Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects
stored in S3 Intelligent-Tiering.
* Bulk - Bulk retrievals are the lowest-cost
retrieval option in S3 Glacier, enabling you to retrieve large amounts, even
petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12
hours for objects stored in the S3 Glacier storage class or S3
Intelligent-Tiering Archive tier. They typically finish within 48 hours for
objects stored in the S3 Glacier Deep Archive storage class or S3
Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects
stored in S3 Intelligent-Tiering.
For more information about archive retrieval
options and provisioned capacity for Expedited data access, see Restoring
Archived Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) in the
Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the
restore speed to a faster speed while it is in progress. For more information,
see Upgrading the speed of an in-progress restore
(https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html)
in the Amazon S3 User Guide. To get the status of object restoration, you can
send a HEAD request. Operations return the x-amz-restore header, which provides
information about the restoration status, in the response. You can use Amazon S3
event notifications to notify you when a restore is initiated or completed. For
more information, see Configuring Amazon S3 Event Notifications
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the
Amazon S3 User Guide. After restoring an archived object, you can update the
restoration period by reissuing the request with a new period. Amazon S3 updates
the restoration period relative to the current time and charges only for the
request-there are no data transfer charges. You cannot update the restoration
period when Amazon S3 is actively processing your current restore request for
the object. If your bucket has a lifecycle configuration with a rule that
includes an expiration action, the object expiration overrides the life span
that you specify in a restore request. For example, if you restore an object
copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3
deletes the object in 3 days. For more information about lifecycle
configuration, see PutBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
and Object Lifecycle Management
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in
Amazon S3 User Guide. Responses A successful action returns either the 200 OK or
202 Accepted status code.
* If the object is not previously restored, then
Amazon S3 returns 202 Accepted in the response.
* If the object is previously
restored, Amazon S3 returns 200 OK in the response.
# Special Errors
* Code:
RestoreAlreadyInProgress
* Cause: Object restore is already in progress. (This
error does not apply to SELECT type requests.)
* HTTP Status Code: 409
Conflict
* SOAP Fault Code Prefix: Client
* Code:
GlacierExpeditedRetrievalNotAvailable
* Cause: expedited retrievals are
currently not available. Try again later. (Returned if there is insufficient
capacity to process the Expedited request. This error applies only to Expedited
retrievals and not to S3 Standard or Bulk retrievals.)
* HTTP Status Code:
503
* SOAP Fault Code Prefix: N/A
# Related Resources
*
PutBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
*
GetBucketNotificationConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
*
SQL Reference for Amazon S3 Select and S3 Glacier Select
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
in the Amazon S3 User Guide
This action filters the contents of an Amazon S3 object based on a simple
structured query language (SQL) statement. In the request, along with the SQL
expression, you must also specify a data serialization format (JSON, CSV, or
Apache Parquet) of the object. Amazon S3 uses this format to parse object data
into records, and returns only records that match the specified SQL expression.
You must also specify the data serialization format for the response. This
action is not supported by Amazon S3 on Outposts. For more information about
Amazon S3 Select, see Selecting Content from Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html)
and SELECT Command
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html)
in the Amazon S3 User Guide. For more information about using SQL with Amazon S3
Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select
(https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
in the Amazon S3 User Guide. Permissions You must have s3:GetObject permission
for this operation. Amazon S3 Select does not support anonymous access. For more
information about permissions, see Specifying Permissions in a Policy
(https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) in
the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to
query objects that have the following format properties:
* CSV, JSON, and
Parquet - Objects must be in CSV, JSON, or Parquet format.
* UTF-8 - UTF-8 is
the only encoding type Amazon S3 Select supports.
* GZIP or BZIP2 - CSV and
JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only
compression formats that Amazon S3 Select supports for CSV and JSON files.
Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy.
Amazon S3 Select does not support whole-object compression for Parquet
objects.
* Server-side encryption - Amazon S3 Select supports querying objects
that are protected with server-side encryption. For objects that are encrypted
with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must
use the headers that are documented in the GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). For more
information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys)
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide. For objects that are encrypted with Amazon S3
managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS),
server-side encryption is handled transparently, so you don't need to specify
anything. For more information about server-side encryption, including SSE-S3
and SSE-KMS, see Protecting Data Using Server-Side Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in
the Amazon S3 User Guide.
Working with the Response Body Given the response
size is unknown, Amazon S3 Select streams the response as a series of messages
and includes a Transfer-Encoding header with chunked as its value in the
response. For more information, see Appendix: SelectObjectContent Response
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html).
GetObject Support The SelectObjectContent action does not support the following
GetObject functionality. For more information, see GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).
* Range:
Although you can specify a scan range for an Amazon S3 Select request (see
SelectObjectContentRequest - ScanRange
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange)
in the request parameters), you cannot specify the range of bytes of an object
to return.
* GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You
cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes.
For more information, about storage classes see Storage Classes
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro)
in the Amazon S3 User Guide.
Special Errors For a list of special errors for
this operation, see List of SELECT Object Content Error Codes
(https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList)
Related Resources
* GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
GetBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
*
PutBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
Uploads a part in a multipart upload. In this operation, you provide part data
in your request. However, you have an option to specify your existing Amazon S3
object as a data source for the part you are uploading. To upload a part from an
existing object, you use the UploadPartCopy
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
operation. You must initiate a multipart upload (see CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html))
before you can upload any part. In response to your initiate request, Amazon S3
returns an upload ID, a unique identifier, that you must include in your upload
part request. Part numbers can be any number from 1 to 10,000, inclusive. A part
number uniquely identifies a part and also defines its position within the
object being created. If you upload a new part using the same part number that
was used with a previous part, the previously uploaded part is overwritten. For
information about maximum and minimum part sizes and other multipart upload
specifications, see Multipart upload limits
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in the
Amazon S3 User Guide. To ensure that data is not corrupted when traversing the
network, specify the Content-MD5 header in the upload part request. Amazon S3
checks the part data against the provided MD5 value. If they do not match,
Amazon S3 returns an error. If the upload request is signed with Signature
Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a
checksum instead of Content-MD5. For more information see Authenticating
Requests: Using the Authorization Header (Amazon Web Services Signature Version
4)
(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html).
Note: After you initiate multipart upload and upload one or more parts, you must
either complete or abort multipart upload in order to stop getting charged for
storage of the uploaded parts. Only after you either complete or abort multipart
upload, Amazon S3 frees up the parts storage and stops charging you for the
parts storage. For more information on multipart uploads, go to Multipart Upload
Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in
the Amazon S3 User Guide . For information on the permissions required to use
the multipart upload API, go to Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) in the
Amazon S3 User Guide. You can optionally request server-side encryption where
Amazon S3 encrypts your data as it writes it to disks in its data centers and
decrypts it for you when you access it. You have the option of providing your
own encryption key, or you can use the Amazon Web Services managed encryption
keys. If you choose to provide your own encryption key, the request headers you
provide in the request must match the headers you used in the request to
initiate the upload by using CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).
For more information, go to Using Server-Side Encryption
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)
in the Amazon S3 User Guide. Server-side encryption is supported by the S3
Multipart Upload actions. Unless you are using a customer-provided encryption
key, you don't need to specify the encryption parameters in each UploadPart
request. Instead, you only need to specify the server-side encryption parameters
in the initial Initiate Multipart request. For more information, see
CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).
If you requested server-side encryption using a customer-provided encryption key
in your initiate multipart upload request, you must provide identical encryption
information in each part upload using the following headers.
*
x-amz-server-side-encryption-customer-algorithm
*
x-amz-server-side-encryption-customer-key
*
x-amz-server-side-encryption-customer-key-MD5
# Special Errors
* Code:
NoSuchUpload
* Cause: 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
# Related Resources
* CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Uploads a part by copying data from an existing object as data source. You
specify the data source by adding the request header x-amz-copy-source in your
request and a byte range by adding the request header x-amz-copy-source-range in
your request. For information about maximum and minimum part sizes and other
multipart upload specifications, see Multipart upload limits
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in the
Amazon S3 User Guide. Instead of using an existing object as part data, you
might use the UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) action and
provide data in your request. You must initiate a multipart upload before you
can upload any part. In response to your initiate request. Amazon S3 returns a
unique identifier, the upload ID, that you must include in your upload part
request. For more information about using the UploadPartCopy operation, see the
following:
* For conceptual information about multipart uploads, see Uploading
Objects Using Multipart Upload
(https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) in the
Amazon S3 User Guide.
* For information about permissions required to use the
multipart upload API, see Multipart Upload and Permissions
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) in the
Amazon S3 User Guide.
* For information about copying objects using a single
atomic action vs. a multipart upload, see Operations on Objects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html) in the
Amazon S3 User Guide.
* For information about using server-side encryption with
customer-provided encryption keys with the UploadPartCopy operation, see
CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
and UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html).
Note the
following additional considerations about the request headers
x-amz-copy-source-if-match, x-amz-copy-source-if-none-match,
x-amz-copy-source-if-unmodified-since, and
x-amz-copy-source-if-modified-since:
* Consideration 1 - If both of the
x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are
present in the request as follows: x-amz-copy-source-if-match condition
evaluates to true, and; x-amz-copy-source-if-unmodified-since condition
evaluates to false; Amazon S3 returns 200 OK and copies the data.
*
Consideration 2 - If both of the x-amz-copy-source-if-none-match and
x-amz-copy-source-if-modified-since headers are present in the request as
follows: x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3
returns 412 Precondition Failed response code.
Versioning If your bucket has
versioning enabled, you could have multiple versions of the same object. By
default, x-amz-copy-source identifies the current version of the object to copy.
If the current version is a delete marker and you don't specify a versionId in
the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does
not exist. If you specify versionId in the x-amz-copy-source and the versionId
is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not
allowed to specify a delete marker as a version for the x-amz-copy-source. You
can optionally specify a specific version of the source object to copy by adding
the versionId subresource as shown in the following example: x-amz-copy-source:
/bucket/object?versionId=version id Special Errors
* Code: NoSuchUpload
*
Cause: 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
* Code: InvalidRequest
* Cause: The specified copy
source is not supported as a byte-range copy source.
* HTTP Status Code: 400
Bad Request
# Related Resources
* CreateMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
UploadPart
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
CompleteMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
AbortMultipartUpload
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
ListParts
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
ListMultipartUploads
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
Passes transformed objects to a GetObject operation when using Object Lambda
access points. For information about Object Lambda access points, see
Transforming objects with Object Lambda access points
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html)
in the Amazon S3 User Guide. This operation supports metadata that can be
returned by GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), in
addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage.
The GetObject response metadata is supported so that the WriteGetObjectResponse
caller, typically an Lambda function, can provide the same metadata when it
internally invokes GetObject. When WriteGetObjectResponse is called by a
customer-owned Lambda function, the metadata returned to the end user GetObject
call might differ from what Amazon S3 would normally return. You can include any
number of metadata headers. When including a metadata header, it should be
prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header:
MyCustomValue. The primary use case for this is to forward GetObject metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use
with S3 Object Lambda to detect and redact personally identifiable information
(PII) and decompress S3 objects. These Lambda functions are available in the
Amazon Web Services Serverless Application Repository, and can be selected
through the Amazon Web Services Management Console when you create your Object
Lambda access point. Example 1: PII Access Control - This Lambda function uses
Amazon Comprehend, a natural language processing (NLP) service using machine
learning to find insights and relationships in text. It automatically detects
personally identifiable information (PII) such as names, addresses, dates,
credit card numbers, and social security numbers from documents in your Amazon
S3 bucket. Example 2: PII Redaction - This Lambda function uses Amazon
Comprehend, a natural language processing (NLP) service using machine learning
to find insights and relationships in text. It automatically redacts personally
identifiable information (PII) such as names, addresses, dates, credit card
numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is
equipped to decompress objects stored in S3 in one of six compressed file
formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. For information
on how to view and use these functions, see Using Amazon Web Services built
Lambda functions
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html) in
the Amazon S3 User Guide.
(*Client) addOperationAbortMultipartUploadMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationCompleteMultipartUploadMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationCopyObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationCreateBucketMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationCreateMultipartUploadMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketAnalyticsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketCorsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketEncryptionMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketIntelligentTieringConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketInventoryConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketLifecycleMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketMetricsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketOwnershipControlsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketPolicyMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketReplicationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteBucketWebsiteMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteObjectTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeleteObjectsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationDeletePublicAccessBlockMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketAccelerateConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketAclMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketAnalyticsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketCorsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketEncryptionMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketIntelligentTieringConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketInventoryConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketLifecycleConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketLocationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketLoggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketMetricsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketNotificationConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketOwnershipControlsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketPolicyMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketPolicyStatusMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketReplicationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketRequestPaymentMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketVersioningMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetBucketWebsiteMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectAclMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectAttributesMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectLegalHoldMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectLockConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectRetentionMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetObjectTorrentMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationGetPublicAccessBlockMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationHeadBucketMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationHeadObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListBucketAnalyticsConfigurationsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListBucketIntelligentTieringConfigurationsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListBucketInventoryConfigurationsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListBucketMetricsConfigurationsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListBucketsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListMultipartUploadsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListObjectVersionsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListObjectsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListObjectsV2Middlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationListPartsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketAccelerateConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketAclMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketAnalyticsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketCorsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketEncryptionMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketIntelligentTieringConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketInventoryConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketLifecycleConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketLoggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketMetricsConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketNotificationConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketOwnershipControlsMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketPolicyMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketReplicationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketRequestPaymentMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketVersioningMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutBucketWebsiteMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectAclMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectLegalHoldMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectLockConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectRetentionMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutObjectTaggingMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationPutPublicAccessBlockMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationRestoreObjectMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationSelectObjectContentMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationUploadPartCopyMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationUploadPartMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) addOperationWriteGetObjectResponseMiddlewares(stack *middleware.Stack, options Options) (err error)(*Client) invokeOperation(ctx context.Context, opID string, params interface{}, optFns []func(*Options), stackFns ...func(*middleware.Stack, Options) error) (result interface{}, metadata middleware.Metadata, err error)
*Client : HeadBucketAPIClient
*Client : HeadObjectAPIClient
*Client : ListObjectsV2APIClient
*Client : ListPartsAPIClient
func New(options Options, optFns ...func(*Options)) *Client
func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
func NewPresignClient(c *Client, optFns ...func(*PresignOptions)) *PresignClient
func finalizeRetryMaxAttemptOptions(o *Options, client Client)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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).
Object key for which the multipart upload was initiated.
This member is required.
The container for the multipart upload request information.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
ID for the initiated multipart upload.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( CompleteMultipartUploadInput) noSmithyDocumentSerde()
CompleteMultipartUploadInput : github.com/aws/smithy-go/document.noSerde
func (*Client).CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error)
func awsRestxml_serializeOpHttpBindingsCompleteMultipartUploadInput(v *CompleteMultipartUploadInput, encoder *httpbinding.Encoder) error
func validateOpCompleteMultipartUploadInput(v *CompleteMultipartUploadInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
Indicates whether the multipart upload uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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.
The object key of the newly created object.
The URI that identifies the newly created object.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
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.
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.
Version ID of the newly created object, in case the bucket has versioning turned
on.
noSmithyDocumentSerdenoSmithyDocumentSerde( CompleteMultipartUploadOutput) noSmithyDocumentSerde()
CompleteMultipartUploadOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error)
func awsRestxml_deserializeOpDocumentCompleteMultipartUploadOutput(v **CompleteMultipartUploadOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsCompleteMultipartUploadOutput(v *CompleteMultipartUploadOutput, response *smithyhttp.Response) error
ComputedInputChecksumsMetadata provides information about the algorithms used to
compute the checksum(s) of the input payload.
ComputedChecksums is a map of algorithm name to checksum value of the computed
input payload's checksums.
func GetComputedInputChecksumsMetadata(m middleware.Metadata) (ComputedInputChecksumsMetadata, bool)
The canned ACL to apply to the object. This action is not supported by Amazon S3
on Outposts.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
Specifies caching behavior along the request/reply chain.
Indicates the algorithm you want Amazon S3 to use to create the checksum for the
object. For more information, see Checking object integrity
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
Specifies presentational information for the object.
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.
The language the content is in.
A standard MIME type describing the format of the object data.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):
*
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:::accesspoint//object/. 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:::outpost//object/. 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= 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.
This member is required.
Copies the object if its entity tag (ETag) matches the specified tag.
Copies the object if it has been modified since the specified time.
Copies the object if its entity tag (ETag) is different than the specified ETag.
Copies the object if it hasn't been modified since the specified time.
Specifies the algorithm to use when decrypting the source object (for example,
AES256).
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.
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.
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).
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).
The date and time at which the object is no longer cacheable.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This
action is not supported by Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata. This action is not
supported by Amazon S3 on Outposts.
Allows grantee to read the object ACL. This action is not supported by Amazon S3
on Outposts.
Allows grantee to write the ACL for the applicable object. This action is not
supported by Amazon S3 on Outposts.
The key of the destination object.
This member is required.
A map of metadata to store with the object in S3.
Specifies whether the metadata is copied from the source object or replaced with
metadata provided in the request.
Specifies whether you want to apply a legal hold to the copied object.
The Object Lock mode that you want to apply to the copied object.
The date and time when you want the copied object's Object Lock to expire.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
in the Amazon S3 User Guide.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in
the Amazon S3 User Guide.
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.
Specifies whether the object tag-set are copied from the source object or
replaced with tag-set provided in the request.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( CopyObjectInput) noSmithyDocumentSerde()
CopyObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).CopyObject(ctx context.Context, params *CopyObjectInput, optFns ...func(*Options)) (*CopyObjectOutput, error)
func awsRestxml_serializeOpHttpBindingsCopyObjectInput(v *CopyObjectInput, encoder *httpbinding.Encoder) error
func validateOpCopyObjectInput(v *CopyObjectInput) error
Indicates whether the copied object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
Container for all response elements.
Version of the copied object in the destination bucket.
If the object expiration is configured, the response includes this header.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
Version ID of the newly created copy.
noSmithyDocumentSerdenoSmithyDocumentSerde( CopyObjectOutput) noSmithyDocumentSerde()
CopyObjectOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).CopyObject(ctx context.Context, params *CopyObjectInput, optFns ...func(*Options)) (*CopyObjectOutput, error)
func awsRestxml_deserializeOpDocumentCopyObjectOutput(v **CopyObjectOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsCopyObjectOutput(v *CopyObjectOutput, response *smithyhttp.Response) error
The canned ACL to apply to the bucket.
The name of the bucket to create.
This member is required.
The configuration information for the bucket.
Allows grantee the read, write, read ACP, and write ACP permissions on the
bucket.
Allows grantee to list the objects in the bucket.
Allows grantee to read the bucket ACL.
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.
Allows grantee to write the ACL for the applicable bucket.
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the
bucket owner if the objects are uploaded with the bucket-owner-full-control
canned ACL. ObjectWriter - The uploading account will own the object if the
object is uploaded with the bucket-owner-full-control canned ACL.
BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer
affect permissions. The bucket owner automatically owns and has full control
over every object in the bucket. The bucket only accepts PUT requests that don't
specify an ACL or bucket owner full control ACLs, such as the
bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed
in the XML format.
noSmithyDocumentSerdenoSmithyDocumentSerde( CreateBucketInput) noSmithyDocumentSerde()
CreateBucketInput : github.com/aws/smithy-go/document.noSerde
func (*Client).CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error)
func awsRestxml_serializeOpHttpBindingsCreateBucketInput(v *CreateBucketInput, encoder *httpbinding.Encoder) error
func validateOpCreateBucketInput(v *CreateBucketInput) error
The canned ACL to apply to the object. This action is not supported by Amazon S3
on Outposts.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
Specifies caching behavior along the request/reply chain.
Indicates the algorithm you want Amazon S3 to use to create the checksum for the
object. For more information, see Checking object integrity
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
Specifies presentational information for the object.
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.
The language the content is in.
A standard MIME type describing the format of the object data.
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).
The date and time at which the object is no longer cacheable.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This
action is not supported by Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata. This action is not
supported by Amazon S3 on Outposts.
Allows grantee to read the object ACL. This action is not supported by Amazon S3
on Outposts.
Allows grantee to write the ACL for the applicable object. This action is not
supported by Amazon S3 on Outposts.
Object key for which the multipart upload is to be initiated.
This member is required.
A map of metadata to store with the object in S3.
Specifies whether you want to apply a legal hold to the uploaded object.
Specifies the Object Lock mode that you want to apply to the uploaded object.
Specifies the date and time when you want the Object Lock to expire.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
in the Amazon S3 User Guide.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in
the Amazon S3 User Guide.
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( CreateMultipartUploadInput) noSmithyDocumentSerde()
CreateMultipartUploadInput : github.com/aws/smithy-go/document.noSerde
func (*Client).CreateMultipartUpload(ctx context.Context, params *CreateMultipartUploadInput, optFns ...func(*Options)) (*CreateMultipartUploadOutput, error)
func awsRestxml_serializeOpHttpBindingsCreateMultipartUploadInput(v *CreateMultipartUploadInput, encoder *httpbinding.Encoder) error
func validateOpCreateMultipartUploadInput(v *CreateMultipartUploadInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
The response also includes the x-amz-abort-rule-id header that provides the ID
of the lifecycle configuration rule that defines this action.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
Indicates whether the multipart upload uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
The algorithm that was used to create a checksum of the object.
Object key for which the multipart upload was initiated.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
ID for the initiated multipart upload.
noSmithyDocumentSerdenoSmithyDocumentSerde( CreateMultipartUploadOutput) noSmithyDocumentSerde()
CreateMultipartUploadOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).CreateMultipartUpload(ctx context.Context, params *CreateMultipartUploadInput, optFns ...func(*Options)) (*CreateMultipartUploadOutput, error)
func awsRestxml_deserializeOpDocumentCreateMultipartUploadOutput(v **CreateMultipartUploadOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsCreateMultipartUploadOutput(v *CreateMultipartUploadOutput, response *smithyhttp.Response) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
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).
Key name of the object to delete.
This member is required.
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.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( DeleteObjectInput) noSmithyDocumentSerde()
DeleteObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error)
func (*PresignClient).PresignDeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
func awsRestxml_serializeOpHttpBindingsDeleteObjectInput(v *DeleteObjectInput, encoder *httpbinding.Encoder) error
func validateOpDeleteObjectInput(v *DeleteObjectInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
Container for the request.
This member is required.
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).
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.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
noSmithyDocumentSerdenoSmithyDocumentSerde( DeleteObjectsInput) noSmithyDocumentSerde()
DeleteObjectsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).DeleteObjects(ctx context.Context, params *DeleteObjectsInput, optFns ...func(*Options)) (*DeleteObjectsOutput, error)
func awsRestxml_serializeOpHttpBindingsDeleteObjectsInput(v *DeleteObjectsInput, encoder *httpbinding.Encoder) error
func validateOpDeleteObjectsInput(v *DeleteObjectsInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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).
The key that identifies the object in the bucket from which to remove all tags.
This member is required.
The versionId of the object that the tag-set will be removed from.
noSmithyDocumentSerdenoSmithyDocumentSerde( DeleteObjectTaggingInput) noSmithyDocumentSerde()
DeleteObjectTaggingInput : github.com/aws/smithy-go/document.noSerde
func (*Client).DeleteObjectTagging(ctx context.Context, params *DeleteObjectTaggingInput, optFns ...func(*Options)) (*DeleteObjectTaggingOutput, error)
func awsRestxml_serializeOpHttpBindingsDeleteObjectTaggingInput(v *DeleteObjectTaggingInput, encoder *httpbinding.Encoder) error
func validateOpDeleteObjectTaggingInput(v *DeleteObjectTaggingInput) error
EndpointResolverFunc is a helper utility that wraps a function so it satisfies
the EndpointResolver interface. This is useful when you want to add additional
endpoint resolving logic, or stub out specific endpoints with custom values.
( EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
EndpointResolverFunc : EndpointResolver
EndpointResolverFunc : github.com/aws/aws-sdk-go-v2/service/s3/internal/customizations.EndpointResolver
EndpointResolverOptions is the service endpoint resolver options
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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).
The key of the object for which to get the ACL information.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectAclInput) noSmithyDocumentSerde()
GetObjectAclInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectAcl(ctx context.Context, params *GetObjectAclInput, optFns ...func(*Options)) (*GetObjectAclOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectAclInput(v *GetObjectAclInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectAclInput(v *GetObjectAclInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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).
The object key.
This member is required.
Sets the maximum number of parts to return.
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.
This member is required.
Specifies the part after which listing should begin. Only parts with higher part
numbers will be listed.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use when encrypting the object (for example, AES256).
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.
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.
The version ID used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectAttributesInput) noSmithyDocumentSerde()
GetObjectAttributesInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectAttributesInput(v *GetObjectAttributesInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectAttributesInput(v *GetObjectAttributesInput) error
The checksum or digest of the object.
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.
An ETag is an opaque identifier assigned by a web server to a specific version
of a resource found at a URL.
The creation date of the object.
A collection of parts associated with a multipart upload.
The size of the object in bytes.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).
The version ID of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectAttributesOutput) noSmithyDocumentSerde()
GetObjectAttributesOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error)
func awsRestxml_deserializeOpDocumentGetObjectAttributesOutput(v **GetObjectAttributesOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsGetObjectAttributesOutput(v *GetObjectAttributesOutput, response *smithyhttp.Response) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
To retrieve the checksum, this mode must be enabled.
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).
Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error.
Return the object only if it has been modified since the specified time;
otherwise, return a 304 (not modified) error.
Return the object only if its entity tag (ETag) is different from the one
specified; otherwise, return a 304 (not modified) error.
Return the object only if it has not been modified since the specified time;
otherwise, return a 412 (precondition failed) error.
Key of the object to get.
This member is required.
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.
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
(https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35). Amazon S3
doesn't support retrieving multiple ranges of data per GET request.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Sets the Cache-Control header of the response.
Sets the Content-Disposition header of the response
Sets the Content-Encoding header of the response.
Sets the Content-Language header of the response.
Sets the Content-Type header of the response.
Sets the Expires header of the response.
Specifies the algorithm to use to when decrypting the object (for example,
AES256).
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.
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.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectInput) noSmithyDocumentSerde()
GetObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error)
func (*PresignClient).PresignGetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
func awsRestxml_serializeOpHttpBindingsGetObjectInput(v *GetObjectInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectInput(v *GetObjectInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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).
The key of the object for which to get the ACL information.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectLegalHoldInput) noSmithyDocumentSerde()
GetObjectLegalHoldInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectLegalHold(ctx context.Context, params *GetObjectLegalHoldInput, optFns ...func(*Options)) (*GetObjectLegalHoldOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectLegalHoldInput(v *GetObjectLegalHoldInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectLegalHoldInput(v *GetObjectLegalHoldInput) error
Indicates that a range of bytes was specified.
Object data.
Indicates whether the object uses an S3 Bucket Key for server-side encryption
with Amazon Web Services KMS (SSE-KMS).
Specifies caching behavior along the request/reply chain.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
Specifies presentational information for the object.
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.
The language the content is in.
Size of the body in bytes.
The portion of the object returned in the response.
A standard MIME type describing the format of the object data.
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.
An entity tag (ETag) is an opaque identifier assigned by a web server to a
specific version of a resource found at a URL.
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.
The date and time at which the object is no longer cacheable.
Creation date of the object.
A map of metadata to store with the object in S3.
Map keys will be normalized to lower-case.
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.
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.
The Object Lock mode currently in place for this object.
The date and time when this object's Object Lock will expire.
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.
Amazon S3 can return this if your request involves a bucket that is either a
source or destination in a replication rule.
If present, indicates that the requester was successfully charged for the
request.
Provides information about object restoration action and expiration time of the
restored object copy.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
Provides storage class information of the object. Amazon S3 returns this header
for all objects except for S3 Standard storage class objects.
The number of tags, if any, on the object.
Version of the object.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectOutput) noSmithyDocumentSerde()
GetObjectOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error)
func awsRestxml_deserializeOpDocumentGetObjectOutput(v *GetObjectOutput, body io.ReadCloser) error
func awsRestxml_deserializeOpHttpBindingsGetObjectOutput(v *GetObjectOutput, response *smithyhttp.Response) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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).
The key of the object for which to get the ACL information.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectRetentionInput) noSmithyDocumentSerde()
GetObjectRetentionInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectRetention(ctx context.Context, params *GetObjectRetentionInput, optFns ...func(*Options)) (*GetObjectRetentionOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectRetentionInput(v *GetObjectRetentionInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectRetentionInput(v *GetObjectRetentionInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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).
The key of the object for which to get the ACL information.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectTaggingInput) noSmithyDocumentSerde()
GetObjectTaggingInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectTagging(ctx context.Context, params *GetObjectTaggingInput, optFns ...func(*Options)) (*GetObjectTaggingOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectTaggingInput(v *GetObjectTaggingInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectTaggingInput(v *GetObjectTaggingInput) error
The name of the bucket containing the object for which to get the torrent files.
This member is required.
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).
The object key for which to get the information.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
noSmithyDocumentSerdenoSmithyDocumentSerde( GetObjectTorrentInput) noSmithyDocumentSerde()
GetObjectTorrentInput : github.com/aws/smithy-go/document.noSerde
func (*Client).GetObjectTorrent(ctx context.Context, params *GetObjectTorrentInput, optFns ...func(*Options)) (*GetObjectTorrentOutput, error)
func awsRestxml_serializeOpHttpBindingsGetObjectTorrentInput(v *GetObjectTorrentInput, encoder *httpbinding.Encoder) error
func validateOpGetObjectTorrentInput(v *GetObjectTorrentInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
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).
Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error.
Return the object only if it has been modified since the specified time;
otherwise, return a 304 (not modified) error.
Return the object only if its entity tag (ETag) is different from the one
specified; otherwise, return a 304 (not modified) error.
Return the object only if it has not been modified since the specified time;
otherwise, return a 412 (precondition failed) error.
The object key.
This member is required.
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.
Because HeadObject returns only the metadata for an object, this parameter has
no effect.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( HeadObjectInput) noSmithyDocumentSerde()
HeadObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).HeadObject(ctx context.Context, params *HeadObjectInput, optFns ...func(*Options)) (*HeadObjectOutput, error)
func HeadObjectAPIClient.HeadObject(context.Context, *HeadObjectInput, ...func(*Options)) (*HeadObjectOutput, error)
func (*ObjectExistsWaiter).Wait(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectExistsWaiterOptions)) error
func (*ObjectExistsWaiter).WaitForOutput(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectExistsWaiterOptions)) (*HeadObjectOutput, error)
func (*ObjectNotExistsWaiter).Wait(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectNotExistsWaiterOptions)) error
func (*ObjectNotExistsWaiter).WaitForOutput(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectNotExistsWaiterOptions)) (*HeadObjectOutput, error)
func (*PresignClient).PresignHeadObject(ctx context.Context, params *HeadObjectInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
func awsRestxml_serializeOpHttpBindingsHeadObjectInput(v *HeadObjectInput, encoder *httpbinding.Encoder) error
func objectExistsStateRetryable(ctx context.Context, input *HeadObjectInput, output *HeadObjectOutput, err error) (bool, error)
func objectNotExistsStateRetryable(ctx context.Context, input *HeadObjectInput, output *HeadObjectOutput, err error) (bool, error)
func validateOpHeadObjectInput(v *HeadObjectInput) error
Indicates that a range of bytes was specified.
The archive state of the head object.
Indicates whether the object uses an S3 Bucket Key for server-side encryption
with Amazon Web Services KMS (SSE-KMS).
Specifies caching behavior along the request/reply chain.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
Specifies presentational information for the object.
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.
The language the content is in.
Size of the body in bytes.
A standard MIME type describing the format of the object data.
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.
An entity tag (ETag) is an opaque identifier assigned by a web server to a
specific version of a resource found at a URL.
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.
The date and time at which the object is no longer cacheable.
Creation date of the object.
A map of metadata to store with the object in S3.
Map keys will be normalized to lower-case.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
The date and time when the Object Lock retention period expires. This header is
only returned if the requester has the s3:GetObjectRetention permission.
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
If present, indicates that the requester was successfully charged for the
request.
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
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) 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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations).
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
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).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).
Version of the object.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( HeadObjectOutput) noSmithyDocumentSerde()
HeadObjectOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).HeadObject(ctx context.Context, params *HeadObjectInput, optFns ...func(*Options)) (*HeadObjectOutput, error)
func HeadObjectAPIClient.HeadObject(context.Context, *HeadObjectInput, ...func(*Options)) (*HeadObjectOutput, error)
func (*ObjectExistsWaiter).WaitForOutput(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectExistsWaiterOptions)) (*HeadObjectOutput, error)
func (*ObjectNotExistsWaiter).WaitForOutput(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectNotExistsWaiterOptions)) (*HeadObjectOutput, error)
func awsRestxml_deserializeOpHttpBindingsHeadObjectOutput(v *HeadObjectOutput, response *smithyhttp.Response) error
func objectExistsStateRetryable(ctx context.Context, input *HeadObjectInput, output *HeadObjectOutput, err error) (bool, error)
func objectNotExistsStateRetryable(ctx context.Context, input *HeadObjectInput, output *HeadObjectOutput, err error) (bool, error)
Do sends an HTTP request and returns an HTTP response.
github.com/aws/aws-sdk-go-v2/aws.HTTPClient(interface)
*github.com/aws/aws-sdk-go-v2/aws/transport/http.BuildableClient
github.com/aws/smithy-go/transport/http.ClientDo(interface)
github.com/aws/smithy-go/transport/http.ClientDoFunc
github.com/aws/smithy-go/transport/http.NopClient
go.pact.im/x/httpclient.Client(interface)
*net/http.Client
*net/http/httputil.ClientConn
HTTPClient : github.com/aws/aws-sdk-go-v2/aws.HTTPClient
HTTPClient : github.com/aws/smithy-go/transport/http.ClientDo
HTTPClient : go.pact.im/x/httpclient.Client
The list of analytics configurations for a bucket.
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.
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.
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.
Metadata pertaining to the operation's result.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListBucketAnalyticsConfigurationsOutput) noSmithyDocumentSerde()
ListBucketAnalyticsConfigurationsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListBucketAnalyticsConfigurations(ctx context.Context, params *ListBucketAnalyticsConfigurationsInput, optFns ...func(*Options)) (*ListBucketAnalyticsConfigurationsOutput, error)
func awsRestxml_deserializeOpDocumentListBucketAnalyticsConfigurationsOutput(v **ListBucketAnalyticsConfigurationsOutput, decoder smithyxml.NodeDecoder) error
The ContinuationToken that represents a placeholder from where this request
should begin.
The list of S3 Intelligent-Tiering configurations for a bucket.
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.
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.
Metadata pertaining to the operation's result.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListBucketIntelligentTieringConfigurationsOutput) noSmithyDocumentSerde()
ListBucketIntelligentTieringConfigurationsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListBucketIntelligentTieringConfigurations(ctx context.Context, params *ListBucketIntelligentTieringConfigurationsInput, optFns ...func(*Options)) (*ListBucketIntelligentTieringConfigurationsOutput, error)
func awsRestxml_deserializeOpDocumentListBucketIntelligentTieringConfigurationsOutput(v **ListBucketIntelligentTieringConfigurationsOutput, decoder smithyxml.NodeDecoder) error
If sent in the request, the marker that is used as a starting point for this
inventory configuration list response.
The list of inventory configurations for a bucket.
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.
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.
Metadata pertaining to the operation's result.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListBucketInventoryConfigurationsOutput) noSmithyDocumentSerde()
ListBucketInventoryConfigurationsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListBucketInventoryConfigurations(ctx context.Context, params *ListBucketInventoryConfigurationsInput, optFns ...func(*Options)) (*ListBucketInventoryConfigurationsOutput, error)
func awsRestxml_deserializeOpDocumentListBucketInventoryConfigurationsOutput(v **ListBucketInventoryConfigurationsOutput, decoder smithyxml.NodeDecoder) error
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.
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.
The list of metrics configurations for a bucket.
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.
Metadata pertaining to the operation's result.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListBucketMetricsConfigurationsOutput) noSmithyDocumentSerde()
ListBucketMetricsConfigurationsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListBucketMetricsConfigurations(ctx context.Context, params *ListBucketMetricsConfigurationsInput, optFns ...func(*Options)) (*ListBucketMetricsConfigurationsOutput, error)
func awsRestxml_deserializeOpDocumentListBucketMetricsConfigurationsOutput(v **ListBucketMetricsConfigurationsOutput, decoder smithyxml.NodeDecoder) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
Requests Amazon S3 to encode the object keys in the response and specifies the
encoding method to use. An object key may contain any Unicode character;
however, XML 1.0 parser cannot parse some characters, such as characters with an
ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you
can add this parameter to request that Amazon S3 encode the keys in the
response.
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).
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.
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.
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.)
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListMultipartUploadsInput) noSmithyDocumentSerde()
ListMultipartUploadsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error)
func awsRestxml_serializeOpHttpBindingsListMultipartUploadsInput(v *ListMultipartUploadsInput, encoder *httpbinding.Encoder) error
func validateOpListMultipartUploadsInput(v *ListMultipartUploadsInput) error
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.
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.
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.
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.
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.
The key at or after which the listing began.
Maximum number of multipart uploads that could have been included in the
response.
When a list is truncated, this element specifies the value that should be used
for the key-marker request parameter in a subsequent request.
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.
When a prefix is provided in the request, this field contains the specified
prefix. The result contains only keys starting with the specified prefix.
Metadata pertaining to the operation's result.
Upload ID after which listing began.
Container for elements related to a particular multipart upload. A response can
contain zero or more Upload elements.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListMultipartUploadsOutput) noSmithyDocumentSerde()
ListMultipartUploadsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error)
func awsRestxml_deserializeOpDocumentListMultipartUploadsOutput(v **ListMultipartUploadsOutput, decoder smithyxml.NodeDecoder) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
A delimiter is a character you use to group keys.
Requests Amazon S3 to encode the object keys in the response and specifies the
encoding method to use. An object key may contain any Unicode character;
however, XML 1.0 parser cannot parse some characters, such as characters with an
ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you
can add this parameter to request that Amazon S3 encode the keys in the
response.
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).
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.
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.
Limits the response to keys that begin with the specified prefix.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectsInput) noSmithyDocumentSerde()
ListObjectsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListObjects(ctx context.Context, params *ListObjectsInput, optFns ...func(*Options)) (*ListObjectsOutput, error)
func awsRestxml_serializeOpHttpBindingsListObjectsInput(v *ListObjectsInput, encoder *httpbinding.Encoder) error
func validateOpListObjectsInput(v *ListObjectsInput) error
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.
Metadata about each object returned.
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.
Encoding type used by Amazon S3 to encode object keys in the response.
A flag that indicates whether Amazon S3 returned all of the results that
satisfied the search criteria.
Indicates where in the bucket listing begins. Marker is included in the response
if it was sent with the request.
The maximum number of keys returned in the response body.
The bucket name.
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.
Keys that begin with the indicated prefix.
Metadata pertaining to the operation's result.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectsOutput) noSmithyDocumentSerde()
ListObjectsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListObjects(ctx context.Context, params *ListObjectsInput, optFns ...func(*Options)) (*ListObjectsOutput, error)
func awsRestxml_deserializeOpDocumentListObjectsOutput(v **ListObjectsOutput, decoder smithyxml.NodeDecoder) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
A delimiter is a character you use to group keys.
Encoding type used by Amazon S3 to encode object keys in the response.
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).
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.
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.
Limits the response to keys that begin with the specified prefix.
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.
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.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectsV2Input) noSmithyDocumentSerde()
ListObjectsV2Input : github.com/aws/smithy-go/document.noSerde
func NewListObjectsV2Paginator(client ListObjectsV2APIClient, params *ListObjectsV2Input, optFns ...func(*ListObjectsV2PaginatorOptions)) *ListObjectsV2Paginator
func (*Client).ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, optFns ...func(*Options)) (*ListObjectsV2Output, error)
func ListObjectsV2APIClient.ListObjectsV2(context.Context, *ListObjectsV2Input, ...func(*Options)) (*ListObjectsV2Output, error)
func awsRestxml_serializeOpHttpBindingsListObjectsV2Input(v *ListObjectsV2Input, encoder *httpbinding.Encoder) error
func validateOpListObjectsV2Input(v *ListObjectsV2Input) error
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.
Metadata about each object returned.
If ContinuationToken was sent with the request, it is included in the response.
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.
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.
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.
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
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
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
Keys that begin with the indicated prefix.
Metadata pertaining to the operation's result.
If StartAfter was sent with the request, it is included in the response.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectsV2Output) noSmithyDocumentSerde()
ListObjectsV2Output : github.com/aws/smithy-go/document.noSerde
func (*Client).ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, optFns ...func(*Options)) (*ListObjectsV2Output, error)
func ListObjectsV2APIClient.ListObjectsV2(context.Context, *ListObjectsV2Input, ...func(*Options)) (*ListObjectsV2Output, error)
func (*ListObjectsV2Paginator).NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectsV2Output, error)
func awsRestxml_deserializeOpDocumentListObjectsV2Output(v **ListObjectsV2Output, decoder smithyxml.NodeDecoder) error
ListObjectsV2PaginatorOptions is the paginator options for ListObjectsV2
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.
Set to true if pagination should stop if the service returns a pagination token
that matches the most recent token provided to the service.
The bucket name that contains the objects.
This member is required.
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.
Requests Amazon S3 to encode the object keys in the response and specifies the
encoding method to use. An object key may contain any Unicode character;
however, XML 1.0 parser cannot parse some characters, such as characters with an
ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you
can add this parameter to request that Amazon S3 encode the keys in the
response.
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).
Specifies the key to start with when listing objects in a bucket.
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 true. To return
the additional keys, see key-marker and version-id-marker.
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.
Specifies the object version you want to start listing from.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectVersionsInput) noSmithyDocumentSerde()
ListObjectVersionsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListObjectVersions(ctx context.Context, params *ListObjectVersionsInput, optFns ...func(*Options)) (*ListObjectVersionsOutput, error)
func awsRestxml_serializeOpHttpBindingsListObjectVersionsInput(v *ListObjectVersionsInput, encoder *httpbinding.Encoder) error
func validateOpListObjectVersionsInput(v *ListObjectVersionsInput) error
All of the keys rolled up into a common prefix count as a single return when
calculating the number of returns.
Container for an object that is a delete marker.
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.
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.
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.
Marks the last key returned in a truncated response.
Specifies the maximum number of objects to return.
The bucket name.
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.
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.
Selects objects that start with the value supplied by this parameter.
Metadata pertaining to the operation's result.
Marks the last version of the key returned in a truncated response.
Container for version information.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListObjectVersionsOutput) noSmithyDocumentSerde()
ListObjectVersionsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListObjectVersions(ctx context.Context, params *ListObjectVersionsInput, optFns ...func(*Options)) (*ListObjectVersionsOutput, error)
func awsRestxml_deserializeOpDocumentListObjectVersionsOutput(v **ListObjectVersionsOutput, decoder smithyxml.NodeDecoder) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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).
Object key for which the multipart upload was initiated.
This member is required.
Sets the maximum number of parts to return.
Specifies the part after which listing should begin. Only parts with higher part
numbers will be listed.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
Upload ID identifying the multipart upload whose parts are being listed.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListPartsInput) noSmithyDocumentSerde()
ListPartsInput : github.com/aws/smithy-go/document.noSerde
func NewListPartsPaginator(client ListPartsAPIClient, params *ListPartsInput, optFns ...func(*ListPartsPaginatorOptions)) *ListPartsPaginator
func (*Client).ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error)
func ListPartsAPIClient.ListParts(context.Context, *ListPartsInput, ...func(*Options)) (*ListPartsOutput, error)
func awsRestxml_serializeOpHttpBindingsListPartsInput(v *ListPartsInput, encoder *httpbinding.Encoder) error
func validateOpListPartsInput(v *ListPartsInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
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.
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.
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.
The algorithm that was used to create a checksum of the object.
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.
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.
Object key for which the multipart upload was initiated.
Maximum number of parts that were allowed in the response.
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.
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.
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.
Container for elements related to a particular part. A response can contain zero
or more Part elements.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded
object.
Upload ID identifying the multipart upload whose parts are being listed.
noSmithyDocumentSerdenoSmithyDocumentSerde( ListPartsOutput) noSmithyDocumentSerde()
ListPartsOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error)
func ListPartsAPIClient.ListParts(context.Context, *ListPartsInput, ...func(*Options)) (*ListPartsOutput, error)
func (*ListPartsPaginator).NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPartsOutput, error)
func awsRestxml_deserializeOpDocumentListPartsOutput(v **ListPartsOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsListPartsOutput(v *ListPartsOutput, response *smithyhttp.Response) error
ListPartsPaginatorOptions is the paginator options for ListParts
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.
Set to true if pagination should stop if the service returns a pagination token
that matches the most recent token provided to the service.
ObjectExistsWaiter defines the waiters for ObjectExists
clientHeadObjectAPIClientoptionsObjectExistsWaiterOptions
Wait calls the waiter function for ObjectExists waiter. The maxWaitDur is the
maximum wait duration the waiter will wait. The maxWaitDur is required and must
be greater than zero.
WaitForOutput calls the waiter function for ObjectExists waiter and returns the
output of the successful operation. The maxWaitDur is the maximum wait duration
the waiter will wait. The maxWaitDur is required and must be greater than zero.
func NewObjectExistsWaiter(client HeadObjectAPIClient, optFns ...func(*ObjectExistsWaiterOptions)) *ObjectExistsWaiter
ObjectExistsWaiterOptions are waiter options for ObjectExistsWaiter
Set of options to modify how an operation is invoked. These apply to all
operations invoked for this client. Use functional options on operation call to
modify this list for per operation behavior.
LogWaitAttempts is used to enable logging for waiter retry attempts
MaxDelay is the maximum amount of time to delay between retries. If unset or set
to zero, ObjectExistsWaiter will use default max delay of 120 seconds. Note that
MaxDelay must resolve to value greater than or equal to the MinDelay.
MinDelay is the minimum amount of time to delay between retries. If unset,
ObjectExistsWaiter will use default minimum delay of 5 seconds. Note that
MinDelay must resolve to a value lesser than or equal to the MaxDelay.
Retryable is function that can be used to override the service defined
waiter-behavior based on operation output, or returned error. This function is
used by the waiter to decide if a state is retryable or a terminal state. By
default service-modeled logic will populate this option. This option can thus be
used to define a custom waiter state with fall-back to service-modeled waiter
state mutators.The function returns an error in case of a failure state. In case
of retry state, this function returns a bool value of true and nil error, while
in case of success it returns a bool value of false and nil error.
ObjectNotExistsWaiter defines the waiters for ObjectNotExists
clientHeadObjectAPIClientoptionsObjectNotExistsWaiterOptions
Wait calls the waiter function for ObjectNotExists waiter. The maxWaitDur is the
maximum wait duration the waiter will wait. The maxWaitDur is required and must
be greater than zero.
WaitForOutput calls the waiter function for ObjectNotExists waiter and returns
the output of the successful operation. The maxWaitDur is the maximum wait
duration the waiter will wait. The maxWaitDur is required and must be greater
than zero.
func NewObjectNotExistsWaiter(client HeadObjectAPIClient, optFns ...func(*ObjectNotExistsWaiterOptions)) *ObjectNotExistsWaiter
ObjectNotExistsWaiterOptions are waiter options for ObjectNotExistsWaiter
Set of options to modify how an operation is invoked. These apply to all
operations invoked for this client. Use functional options on operation call to
modify this list for per operation behavior.
LogWaitAttempts is used to enable logging for waiter retry attempts
MaxDelay is the maximum amount of time to delay between retries. If unset or set
to zero, ObjectExistsWaiter will use default max delay of 120 seconds. Note that
MaxDelay must resolve to value greater than or equal to the MinDelay.
MinDelay is the minimum amount of time to delay between retries. If unset,
ObjectExistsWaiter will use default minimum delay of 5 seconds. Note that
MinDelay must resolve to a value lesser than or equal to the MaxDelay.
Retryable is function that can be used to override the service defined
waiter-behavior based on operation output, or returned error. This function is
used by the waiter to decide if a state is retryable or a terminal state. By
default service-modeled logic will populate this option. This option can thus be
used to define a custom waiter state with fall-back to service-modeled waiter
state mutators.The function returns an error in case of a failure state. In case
of retry state, this function returns a bool value of true and nil error, while
in case of success it returns a bool value of false and nil error.
PresignClient represents the presign url client
client*ClientoptionsPresignOptions
PresignDeleteBucket is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignDeleteObject is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignGetObject is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignHeadBucket is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignHeadObject is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignPutObject is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
PresignUploadPart is used to generate a presigned HTTP Request which contains
presigned URL, signed headers and HTTP method used.
func NewPresignClient(c *Client, optFns ...func(*PresignOptions)) *PresignClient
PresignOptions represents the presign client options
ClientOptions are list of functional options to mutate client options used by
the presign client.
Expires sets the expiration duration for the generated presign url. This should
be the duration in seconds the presigned URL should be considered valid for. If
not set or set to zero, presign url would default to expire after 900 seconds.
Presigner is the presigner used by the presign url client
presignerV4a is the presigner used by the presign url client
( PresignOptions) copy() PresignOptions
func PresignOptions.copy() PresignOptions
Container for setting the transfer acceleration state.
This member is required.
The name of the bucket for which the accelerate configuration is set.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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).
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketAccelerateConfigurationInput) noSmithyDocumentSerde()
PutBucketAccelerateConfigurationInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketAccelerateConfiguration(ctx context.Context, params *PutBucketAccelerateConfigurationInput, optFns ...func(*Options)) (*PutBucketAccelerateConfigurationOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketAccelerateConfigurationInput(v *PutBucketAccelerateConfigurationInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketAccelerateConfigurationInput(v *PutBucketAccelerateConfigurationInput) error
The canned ACL to apply to the bucket.
Contains the elements that set the ACL permissions for an object per grantee.
The bucket to which to apply the ACL.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
(http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
Allows grantee the read, write, read ACP, and write ACP permissions on the
bucket.
Allows grantee to list the objects in the bucket.
Allows grantee to read the bucket ACL.
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.
Allows grantee to write the ACL for the applicable bucket.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketAclInput) noSmithyDocumentSerde()
PutBucketAclInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketAcl(ctx context.Context, params *PutBucketAclInput, optFns ...func(*Options)) (*PutBucketAclOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketAclInput(v *PutBucketAclInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketAclInput(v *PutBucketAclInput) error
Specifies the bucket impacted by the corsconfiguration.
This member is required.
Describes the cross-origin access configuration for objects in an Amazon S3
bucket. For more information, see Enabling Cross-Origin Resource Sharing
(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3
User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
(http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketCorsInput) noSmithyDocumentSerde()
PutBucketCorsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketCors(ctx context.Context, params *PutBucketCorsInput, optFns ...func(*Options)) (*PutBucketCorsOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketCorsInput(v *PutBucketCorsInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketCorsInput(v *PutBucketCorsInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
Specifies the default server-side-encryption configuration.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketEncryptionInput) noSmithyDocumentSerde()
PutBucketEncryptionInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketEncryption(ctx context.Context, params *PutBucketEncryptionInput, optFns ...func(*Options)) (*PutBucketEncryptionOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketEncryptionInput(v *PutBucketEncryptionInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketEncryptionInput(v *PutBucketEncryptionInput) error
The name of the bucket for which to set the configuration.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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).
Container for lifecycle rules. You can add as many as 1,000 rules.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketLifecycleConfigurationInput) noSmithyDocumentSerde()
PutBucketLifecycleConfigurationInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*PutBucketLifecycleConfigurationOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketLifecycleConfigurationInput(v *PutBucketLifecycleConfigurationInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketLifecycleConfigurationInput(v *PutBucketLifecycleConfigurationInput) error
The name of the bucket for which to set the logging parameters.
This member is required.
Container for logging status information.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketLoggingInput) noSmithyDocumentSerde()
PutBucketLoggingInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketLogging(ctx context.Context, params *PutBucketLoggingInput, optFns ...func(*Options)) (*PutBucketLoggingOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketLoggingInput(v *PutBucketLoggingInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketLoggingInput(v *PutBucketLoggingInput) error
The name of the Amazon S3 bucket whose OwnershipControls you want to set.
This member is required.
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.
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).
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or
ObjectWriter) that you want to apply to this Amazon S3 bucket.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketOwnershipControlsInput) noSmithyDocumentSerde()
PutBucketOwnershipControlsInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketOwnershipControls(ctx context.Context, params *PutBucketOwnershipControlsInput, optFns ...func(*Options)) (*PutBucketOwnershipControlsOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketOwnershipControlsInput(v *PutBucketOwnershipControlsInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketOwnershipControlsInput(v *PutBucketOwnershipControlsInput) error
The name of the bucket.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
Set this parameter to true to confirm that you want to remove your permissions
to change this bucket policy in the future.
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.
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).
The bucket policy as a JSON document.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketPolicyInput) noSmithyDocumentSerde()
PutBucketPolicyInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketPolicyInput(v *PutBucketPolicyInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketPolicyInput(v *PutBucketPolicyInput) error
The name of the bucket
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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
(http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
A container for replication rules. You can add up to 1,000 rules. The maximum
size of a replication configuration is 2 MB.
This member is required.
A token to allow Object Lock to be enabled for an existing bucket.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketReplicationInput) noSmithyDocumentSerde()
PutBucketReplicationInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketReplication(ctx context.Context, params *PutBucketReplicationInput, optFns ...func(*Options)) (*PutBucketReplicationOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketReplicationInput(v *PutBucketReplicationInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketReplicationInput(v *PutBucketReplicationInput) error
The bucket name.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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
(http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
Container for Payer.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketRequestPaymentInput) noSmithyDocumentSerde()
PutBucketRequestPaymentInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketRequestPayment(ctx context.Context, params *PutBucketRequestPaymentInput, optFns ...func(*Options)) (*PutBucketRequestPaymentOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketRequestPaymentInput(v *PutBucketRequestPaymentInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketRequestPaymentInput(v *PutBucketRequestPaymentInput) error
The bucket name.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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
(http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
Container for the TagSet and Tag elements.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketTaggingInput) noSmithyDocumentSerde()
PutBucketTaggingInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketTaggingInput(v *PutBucketTaggingInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketTaggingInput(v *PutBucketTaggingInput) error
The bucket name.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
>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
(http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
The concatenation of the authentication device's serial number, a space, and the
value that is displayed on your authentication device.
Container for setting the versioning state.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketVersioningInput) noSmithyDocumentSerde()
PutBucketVersioningInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketVersioning(ctx context.Context, params *PutBucketVersioningInput, optFns ...func(*Options)) (*PutBucketVersioningOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketVersioningInput(v *PutBucketVersioningInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketVersioningInput(v *PutBucketVersioningInput) error
The bucket name.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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
(http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
Container for the request.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutBucketWebsiteInput) noSmithyDocumentSerde()
PutBucketWebsiteInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutBucketWebsite(ctx context.Context, params *PutBucketWebsiteInput, optFns ...func(*Options)) (*PutBucketWebsiteOutput, error)
func awsRestxml_serializeOpHttpBindingsPutBucketWebsiteInput(v *PutBucketWebsiteInput, encoder *httpbinding.Encoder) error
func validateOpPutBucketWebsiteInput(v *PutBucketWebsiteInput) error
The canned ACL to apply to the object. For more information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
Contains the elements that set the ACL permissions for an object per grantee.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.>
(http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
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).
Allows grantee the read, write, read ACP, and write ACP permissions on the
bucket. This action is not supported by Amazon S3 on Outposts.
Allows grantee to list the objects in the bucket. This action is not supported
by Amazon S3 on Outposts.
Allows grantee to read the bucket ACL. This action is not supported by Amazon S3
on Outposts.
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.
Allows grantee to write the ACL for the applicable bucket. This action is not
supported by Amazon S3 on Outposts.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectAclInput) noSmithyDocumentSerde()
PutObjectAclInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObjectAcl(ctx context.Context, params *PutObjectAclInput, optFns ...func(*Options)) (*PutObjectAclOutput, error)
func awsRestxml_serializeOpHttpBindingsPutObjectAclInput(v *PutObjectAclInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectAclInput(v *PutObjectAclInput) error
The canned ACL to apply to the object. For more information, see Canned ACL
(https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
This action is not supported by Amazon S3 on Outposts.
Object data.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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.
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
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
Specifies presentational information for the object. For more information, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1).
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
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11).
The language the content is in.
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
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
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
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).
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).
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
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21).
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This
action is not supported by Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata. This action is not
supported by Amazon S3 on Outposts.
Allows grantee to read the object ACL. This action is not supported by Amazon S3
on Outposts.
Allows grantee to write the ACL for the applicable object. This action is not
supported by Amazon S3 on Outposts.
Object key for which the PUT action was initiated.
This member is required.
A map of metadata to store with the object in S3.
Specifies whether a legal hold will be applied to this object. For more
information about S3 Object Lock, see Object Lock
(https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
The Object Lock mode that you want to apply to this object.
The date and time when you want this object's Object Lock to expire. Must be
formatted as a timestamp parameter.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in
the Amazon S3 User Guide.
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
(For example, "Key1=Value1")
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html). 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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) and How to
Configure Website Page Redirects
(https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html).
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectInput) noSmithyDocumentSerde()
PutObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error)
func (*PresignClient).PresignPutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
func awsRestxml_serializeOpHttpBindingsPutObjectInput(v *PutObjectInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectInput(v *PutObjectInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
The key name for the object that you want to place a legal hold on.
This member is required.
Container element for the legal hold configuration you want to apply to the
specified object.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
The version ID of the object that you want to place a legal hold on.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectLegalHoldInput) noSmithyDocumentSerde()
PutObjectLegalHoldInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObjectLegalHold(ctx context.Context, params *PutObjectLegalHoldInput, optFns ...func(*Options)) (*PutObjectLegalHoldOutput, error)
func awsRestxml_serializeOpHttpBindingsPutObjectLegalHoldInput(v *PutObjectLegalHoldInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectLegalHoldInput(v *PutObjectLegalHoldInput) error
The bucket whose Object Lock configuration you want to create or replace.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
The Object Lock configuration that you want to apply to the specified bucket.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
A token to allow Object Lock to be enabled for an existing bucket.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectLockConfigurationInput) noSmithyDocumentSerde()
PutObjectLockConfigurationInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObjectLockConfiguration(ctx context.Context, params *PutObjectLockConfigurationInput, optFns ...func(*Options)) (*PutObjectLockConfigurationOutput, error)
func awsRestxml_serializeOpHttpBindingsPutObjectLockConfigurationInput(v *PutObjectLockConfigurationInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectLockConfigurationInput(v *PutObjectLockConfigurationInput) error
Indicates whether the uploaded object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
Entity tag for the uploaded object.
If the expiration is configured for the object (see
PutBucketLifecycleConfiguration
(https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)),
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.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
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.
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.
Version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectOutput) noSmithyDocumentSerde()
PutObjectOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error)
func awsRestxml_deserializeOpHttpBindingsPutObjectOutput(v *PutObjectOutput, response *smithyhttp.Response) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
in the Amazon S3 User Guide.
This member is required.
Indicates whether this action should bypass Governance-mode restrictions.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
The key name for the object that you want to apply this Object Retention
configuration to.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
The container element for the Object Retention configuration.
The version ID for the object that you want to apply this Object Retention
configuration to.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectRetentionInput) noSmithyDocumentSerde()
PutObjectRetentionInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObjectRetention(ctx context.Context, params *PutObjectRetentionInput, optFns ...func(*Options)) (*PutObjectRetentionOutput, error)
func awsRestxml_serializeOpHttpBindingsPutObjectRetentionInput(v *PutObjectRetentionInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectRetentionInput(v *PutObjectRetentionInput) error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
Name of the object key.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Container for the TagSet and Tag elements
This member is required.
The versionId of the object that the tag-set will be added to.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutObjectTaggingInput) noSmithyDocumentSerde()
PutObjectTaggingInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutObjectTagging(ctx context.Context, params *PutObjectTaggingInput, optFns ...func(*Options)) (*PutObjectTaggingOutput, error)
func awsRestxml_serializeOpHttpBindingsPutObjectTaggingInput(v *PutObjectTaggingInput, encoder *httpbinding.Encoder) error
func validateOpPutObjectTaggingInput(v *PutObjectTaggingInput) error
The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want
to set.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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.
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).
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"
(https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)
in the Amazon S3 User Guide.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( PutPublicAccessBlockInput) noSmithyDocumentSerde()
PutPublicAccessBlockInput : github.com/aws/smithy-go/document.noSerde
func (*Client).PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, error)
func awsRestxml_serializeOpHttpBindingsPutPublicAccessBlockInput(v *PutPublicAccessBlockInput, encoder *httpbinding.Encoder) error
func validateOpPutPublicAccessBlockInput(v *PutPublicAccessBlockInput) error
ResponseError provides the HTTP centric error type wrapping the underlying error
with the HTTP response value and the deserialized RequestID.
( ResponseError) Error() builtin.string( ResponseError) ServiceHostID() string( ResponseError) ServiceRequestID() string
*github.com/aws/aws-sdk-go-v2/service/internal/s3shared.ResponseError
ResponseError : error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
ignores any provided ChecksumAlgorithm parameter.
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).
Object key for which the action was initiated.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Container for restore job parameters.
VersionId used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( RestoreObjectInput) noSmithyDocumentSerde()
RestoreObjectInput : github.com/aws/smithy-go/document.noSerde
func (*Client).RestoreObject(ctx context.Context, params *RestoreObjectInput, optFns ...func(*Options)) (*RestoreObjectOutput, error)
func awsRestxml_serializeOpHttpBindingsRestoreObjectInput(v *RestoreObjectInput, encoder *httpbinding.Encoder) error
func validateOpRestoreObjectInput(v *RestoreObjectInput) error
SelectObjectContentEventStream provides the event stream handling for the SelectObjectContent operation.
For testing and mocking the event stream this type should be initialized via
the NewSelectObjectContentEventStream constructor function. Using the functional options
to pass in nested mock behavior.
SelectObjectContentEventStreamReader is the EventStream reader for the
SelectObjectContentEventStream events. This value is automatically set by the
SDK when the API call is made Use this member when unit testing your code with
the SDK to mock out the EventStream Reader.
Must not be nil.
closeOncesync.Oncedonechan struct{}err*smithysync.OnceErr
Close closes the stream. This will also cause the stream to be closed.
Close must be called when done using the stream API. Not calling Close
may result in resource leaks.
Will close the underlying EventStream writer and reader, and no more events can be
sent or received.
Err returns any error that occurred while reading or writing EventStream Events
from the service API's response. Returns nil if there were no errors.
Events returns a channel to read events from.
(*SelectObjectContentEventStream) safeClose()(*SelectObjectContentEventStream) waitStreamClose()
*SelectObjectContentEventStream : SelectObjectContentEventStreamReader
*SelectObjectContentEventStream : io.Closer
func NewSelectObjectContentEventStream(optFns ...func(*SelectObjectContentEventStream)) *SelectObjectContentEventStream
func (*SelectObjectContentOutput).GetStream() *SelectObjectContentEventStream
Request to filter the contents of an Amazon S3 object based on a simple
Structured Query Language (SQL) statement. In the request, along with the SQL
expression, you must specify a data serialization format (JSON or CSV) of the
object. Amazon S3 uses this to parse object data into records. It returns only
records that match the specified SQL expression. You must also specify the data
serialization format for the response. For more information, see S3Select API
Documentation
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html).
The S3 bucket.
This member is required.
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).
The expression that is used to query the object.
This member is required.
The type of the provided expression (for example, SQL).
This member is required.
Describes the format of the data in the object that is being queried.
This member is required.
The object key.
This member is required.
Describes the format of the data that you want Amazon S3 to return in response.
This member is required.
Specifies if periodic request progress information should be enabled.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the Amazon S3 User Guide.
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:
* 50100 - process only the records starting between
the bytes 50 and 100 (inclusive, counting from zero)
* 50 - process only the
records starting after the byte 50
* 50 - process only the records within the
last 50 bytes of the file.
noSmithyDocumentSerdenoSmithyDocumentSerde( SelectObjectContentInput) noSmithyDocumentSerde()
SelectObjectContentInput : github.com/aws/smithy-go/document.noSerde
func (*Client).SelectObjectContent(ctx context.Context, params *SelectObjectContentInput, optFns ...func(*Options)) (*SelectObjectContentOutput, error)
func awsRestxml_serializeOpDocumentSelectObjectContentInput(v *SelectObjectContentInput, value smithyxml.Value) error
func awsRestxml_serializeOpHttpBindingsSelectObjectContentInput(v *SelectObjectContentInput, encoder *httpbinding.Encoder) error
func validateOpSelectObjectContentInput(v *SelectObjectContentInput) error
UnknownEventMessageError provides an error when a message is received from the stream,
but the reader is unable to determine what kind of message it is.
Message*eventstream.MessageTypestring
Error retruns the error message string.
*UnknownEventMessageError : error
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):
*
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:::accesspoint//object/. 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:::outpost//object/. 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= 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.
This member is required.
Copies the object if its entity tag (ETag) matches the specified tag.
Copies the object if it has been modified since the specified time.
Copies the object if its entity tag (ETag) is different than the specified ETag.
Copies the object if it hasn't been modified since the specified time.
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.
Specifies the algorithm to use when decrypting the source object (for example,
AES256).
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.
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.
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).
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).
Object key for which the multipart upload was initiated.
This member is required.
Part number of part being copied. This is a positive integer between 1 and
10,000.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
Upload ID identifying the multipart upload whose part is being copied.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( UploadPartCopyInput) noSmithyDocumentSerde()
UploadPartCopyInput : github.com/aws/smithy-go/document.noSerde
func (*Client).UploadPartCopy(ctx context.Context, params *UploadPartCopyInput, optFns ...func(*Options)) (*UploadPartCopyOutput, error)
func awsRestxml_serializeOpHttpBindingsUploadPartCopyInput(v *UploadPartCopyInput, encoder *httpbinding.Encoder) error
func validateOpUploadPartCopyInput(v *UploadPartCopyInput) error
Indicates whether the multipart upload uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
Container for all response elements.
The version of the source object that was copied, if you have enabled versioning
on the source bucket.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
noSmithyDocumentSerdenoSmithyDocumentSerde( UploadPartCopyOutput) noSmithyDocumentSerde()
UploadPartCopyOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).UploadPartCopy(ctx context.Context, params *UploadPartCopyInput, optFns ...func(*Options)) (*UploadPartCopyOutput, error)
func awsRestxml_deserializeOpDocumentUploadPartCopyOutput(v **UploadPartCopyOutput, decoder smithyxml.NodeDecoder) error
func awsRestxml_deserializeOpHttpBindingsUploadPartCopyOutput(v *UploadPartCopyOutput, response *smithyhttp.Response) error
Object data.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the
Amazon S3 User Guide.
This member is required.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
in the Amazon S3 User Guide.
Size of the body in bytes. This parameter is useful when the size of the body
cannot be determined automatically.
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.
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).
Object key for which the multipart upload was initiated.
This member is required.
Part number of part being uploaded. This is a positive integer between 1 and
10,000.
This member is required.
Confirms that the requester knows that they will be charged for the request.
Bucket owners need not specify this parameter in their requests. For information
about downloading objects from Requester Pays buckets, see Downloading Objects
in Requester Pays Buckets
(https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
in the Amazon S3 User Guide.
Specifies the algorithm to use to when encrypting the object (for example,
AES256).
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.
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.
Upload ID identifying the multipart upload whose part is being uploaded.
This member is required.
noSmithyDocumentSerdenoSmithyDocumentSerde( UploadPartInput) noSmithyDocumentSerde()
UploadPartInput : github.com/aws/smithy-go/document.noSerde
func (*Client).UploadPart(ctx context.Context, params *UploadPartInput, optFns ...func(*Options)) (*UploadPartOutput, error)
func (*PresignClient).PresignUploadPart(ctx context.Context, params *UploadPartInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
func awsRestxml_serializeOpHttpBindingsUploadPartInput(v *UploadPartInput, encoder *httpbinding.Encoder) error
func validateOpUploadPartInput(v *UploadPartInput) error
Indicates whether the multipart upload uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums)
in the Amazon S3 User Guide.
Entity tag for the uploaded object.
If present, indicates that the requester was successfully charged for the
request.
Metadata pertaining to the operation's result.
If server-side encryption with a customer-provided encryption key was requested,
the response will include this header confirming the encryption algorithm used.
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.
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.
The server-side encryption algorithm used when storing this object in Amazon S3
(for example, AES256, aws:kms).
noSmithyDocumentSerdenoSmithyDocumentSerde( UploadPartOutput) noSmithyDocumentSerde()
UploadPartOutput : github.com/aws/smithy-go/document.noSerde
func (*Client).UploadPart(ctx context.Context, params *UploadPartInput, optFns ...func(*Options)) (*UploadPartOutput, error)
func awsRestxml_deserializeOpHttpBindingsUploadPartOutput(v *UploadPartOutput, response *smithyhttp.Response) error
Indicates that a range of bytes was specified.
The object data.
Indicates whether the object stored in Amazon S3 uses an S3 bucket key for
server-side encryption with Amazon Web Services KMS (SSE-KMS).
Specifies caching behavior along the request/reply chain.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
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
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
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.
Specifies presentational information for the object.
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.
The language the content is in.
The size of the content body in bytes.
The portion of the object returned in the response.
A standard MIME type describing the format of the object data.
Specifies whether an object stored in Amazon S3 is (true) or is not (false) a
delete marker.
An opaque identifier assigned by a web server to a specific version of a
resource found at a URL.
A string that uniquely identifies an error condition. Returned in the 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]+$".
Contains a generic description of the error condition. Returned in the 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.
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.
The date and time at which the object is no longer cacheable.
The date and time that the object was last modified.
A map of metadata to store with the object in S3.
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.
Indicates whether an object stored in Amazon S3 has an active legal hold.
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For
more information about S3 Object Lock, see Object Lock
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html).
The date and time when Object Lock is configured to expire.
The count of parts this object has.
Indicates if request involves bucket that is either a source or destination in a
Replication rule. For more information about S3 Replication, see Replication
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html).
If present, indicates that the requester was successfully charged for the
request.
Route prefix to the HTTP URL generated.
This member is required.
A single use encrypted token that maps WriteGetObjectResponse to the end user
GetObject request.
This member is required.
Provides information about object restoration operation and expiration time of
the restored object copy.
Encryption algorithm used if server-side encryption with a customer-provided
encryption key was specified for object stored in Amazon S3.
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)
(https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).
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.
The server-side encryption algorithm used when storing requested object in
Amazon S3 (for example, AES256, aws:kms).
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
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
(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).
The number of tags, if any, on the object.
An ID used to reference a specific version of the object.
noSmithyDocumentSerdenoSmithyDocumentSerde( WriteGetObjectResponseInput) noSmithyDocumentSerde()
WriteGetObjectResponseInput : github.com/aws/smithy-go/document.noSerde
func (*Client).WriteGetObjectResponse(ctx context.Context, params *WriteGetObjectResponseInput, optFns ...func(*Options)) (*WriteGetObjectResponseOutput, error)
func awsRestxml_serializeOpHttpBindingsWriteGetObjectResponseInput(v *WriteGetObjectResponseInput, encoder *httpbinding.Encoder) error
func validateOpWriteGetObjectResponseInput(v *WriteGetObjectResponseInput) error
ClientOptions are list of functional options to mutate client options used by
the presign client.
Expires sets the expiration duration for the generated presign url. This should
be the duration in seconds the presigned URL should be considered valid for. If
not set or set to zero, presign url would default to expire after 900 seconds.
Presigner is the presigner used by the presign url client
presignerV4a is the presigner used by the presign url client
( presignConverter) convertToPresignMiddleware(stack *middleware.Stack, options Options) (err error)
Package-Level Functions (total 1243, in which 19 are exported)
EndpointResolverFromURL returns an EndpointResolver configured using the
provided endpoint url. By default, the resolved endpoint resolver uses the
client region as signing region, and the endpoint source is set to
EndpointSourceCustom.You can provide functional options to configure endpoint
values for the resolved endpoint.
GetChecksumValidationMetadata returns the set of algorithms that will be used to
validate the response payload with. The response payload must be completely read
in order for the checksum validation to be performed. An error is returned by
the operation output's response io.ReadCloser if the computed checksums are
invalid. Returns false if no checksum algorithm used metadata was found.
GetComputedInputChecksumsMetadata retrieves from the result metadata the map of
algorithms and input payload checksums values.
GetHostIDMetadata retrieves the host id from middleware metadata returns host id
as string along with a boolean indicating presence of hostId on middleware
metadata.
New returns an initialized Client based on the functional options. Provide
additional functional options to further configure the behavior of the client,
such as changing the client's endpoint or adding custom middleware behavior.
NewBucketExistsWaiter constructs a BucketExistsWaiter.
NewBucketNotExistsWaiter constructs a BucketNotExistsWaiter.
NewDefaultEndpointResolver constructs a new service endpoint resolver
NewFromConfig returns a new client from the provided config.
NewListObjectsV2Paginator returns a new ListObjectsV2Paginator
NewListPartsPaginator returns a new ListPartsPaginator
NewObjectExistsWaiter constructs a ObjectExistsWaiter.
NewObjectNotExistsWaiter constructs a ObjectNotExistsWaiter.
NewPresignClient generates a presign client using provided API Client and
presign options
NewSelectObjectContentEventStream initializes an SelectObjectContentEventStream.
This function should only be used for testing and mocking the SelectObjectContentEventStream
stream within your application.
The Reader member must be set before reading events from the stream.
WithAPIOptions returns a functional option for setting the Client's APIOptions
option.
WithEndpointResolver returns a functional option for setting the Client's
EndpointResolver option.
WithPresignClientFromClientOptions is a helper utility to retrieve a function
that takes PresignOption as input
WithPresignExpires is a helper utility to append Expires value on presign
options optional function
getAbortMultipartUploadBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getCompleteMultipartUploadBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getCopyObjectBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getCreateBucketBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getCreateMultipartUploadBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketAnalyticsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getDeleteBucketBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getDeleteBucketCorsBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getDeleteBucketEncryptionBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketIntelligentTieringConfigurationBucketMember returns a pointer to
string denoting a provided bucket member valueand a boolean indicating if the
input has a modeled bucket name,
getDeleteBucketInventoryConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getDeleteBucketLifecycleBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketMetricsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getDeleteBucketOwnershipControlsBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getDeleteBucketPolicyBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketReplicationBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketTaggingBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteBucketWebsiteBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeleteObjectBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getDeleteObjectsBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getDeleteObjectsRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getDeleteObjectTaggingBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getDeletePublicAccessBlockBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketAccelerateConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketAclBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketAnalyticsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketCorsBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketEncryptionBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketIntelligentTieringConfigurationBucketMember returns a pointer to
string denoting a provided bucket member valueand a boolean indicating if the
input has a modeled bucket name,
getGetBucketInventoryConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketLifecycleConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketLocationBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketLoggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketMetricsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketNotificationConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getGetBucketOwnershipControlsBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketPolicyBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketPolicyStatusBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketReplicationBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketRequestPaymentBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketTaggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetBucketVersioningBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetBucketWebsiteBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetObjectAclBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetObjectAttributesBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetObjectBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getGetObjectLegalHoldBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetObjectLockConfigurationBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetObjectRequestValidationModeMember gets the request checksum validation
mode provided as input.
getGetObjectRetentionBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getGetObjectTaggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetObjectTorrentBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getGetPublicAccessBlockBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getHeadBucketBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getHeadObjectBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getListBucketAnalyticsConfigurationsBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getListBucketIntelligentTieringConfigurationsBucketMember returns a pointer to
string denoting a provided bucket member valueand a boolean indicating if the
input has a modeled bucket name,
getListBucketInventoryConfigurationsBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getListBucketMetricsConfigurationsBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getListMultipartUploadsBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getListObjectsBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getListObjectsV2BucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getListObjectVersionsBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getListPartsBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getPutBucketAccelerateConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketAccelerateConfigurationRequestAlgorithmMember gets the request
checksum algorithm value provided as input.
getPutBucketAclBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketAclRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getPutBucketAnalyticsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketCorsBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketCorsRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getPutBucketEncryptionBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutBucketEncryptionRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutBucketIntelligentTieringConfigurationBucketMember returns a pointer to
string denoting a provided bucket member valueand a boolean indicating if the
input has a modeled bucket name,
getPutBucketInventoryConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketLifecycleConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketLifecycleConfigurationRequestAlgorithmMember gets the request
checksum algorithm value provided as input.
getPutBucketLoggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketLoggingRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutBucketMetricsConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketNotificationConfigurationBucketMember returns a pointer to string
denoting a provided bucket member valueand a boolean indicating if the input has
a modeled bucket name,
getPutBucketOwnershipControlsBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutBucketPolicyBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketPolicyRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutBucketReplicationBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutBucketReplicationRequestAlgorithmMember gets the request checksum
algorithm value provided as input.
getPutBucketRequestPaymentBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutBucketRequestPaymentRequestAlgorithmMember gets the request checksum
algorithm value provided as input.
getPutBucketTaggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketTaggingRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutBucketVersioningBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutBucketVersioningRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutBucketWebsiteBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutBucketWebsiteRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutObjectAclBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutObjectAclRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getPutObjectBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getPutObjectLegalHoldBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutObjectLegalHoldRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutObjectLockConfigurationBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutObjectLockConfigurationRequestAlgorithmMember gets the request checksum
algorithm value provided as input.
getPutObjectRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getPutObjectRetentionBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutObjectRetentionRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutObjectTaggingBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getPutObjectTaggingRequestAlgorithmMember gets the request checksum algorithm
value provided as input.
getPutPublicAccessBlockBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getPutPublicAccessBlockRequestAlgorithmMember gets the request checksum
algorithm value provided as input.
getRestoreObjectBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getRestoreObjectRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
getSelectObjectContentBucketMember returns a pointer to string denoting a
provided bucket member valueand a boolean indicating if the input has a modeled
bucket name,
getUploadPartBucketMember returns a pointer to string denoting a provided bucket
member valueand a boolean indicating if the input has a modeled bucket name,
getUploadPartCopyBucketMember returns a pointer to string denoting a provided
bucket member valueand a boolean indicating if the input has a modeled bucket
name,
getUploadPartRequestAlgorithmMember gets the request checksum algorithm value
provided as input.
withEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver.
If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided
fallbackResolver for resolution.
fallbackResolver must not be nil