Class AmazonS3Client

Namespace

Amazon.S3

Assembly

AWSSDK.S3.dll

Implementation for accessing S3

public class AmazonS3Client : AmazonServiceClient, IAmazonS3, IDisposable, ICoreAmazonS3, IAmazonService

Inheritance

object

AmazonS3Client

Implements

IAmazonS3

IDisposable

ICoreAmazonS3

IAmazonService

Derived

AmazonS3EncryptionClient

Constructors

AmazonS3Client()

Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3Client()

AmazonS3Client(RegionEndpoint)

Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3Client(RegionEndpoint region)

Parameters

region RegionEndpoint

The region to connect.

AmazonS3Client(AWSCredentials)

Constructs AmazonS3Client with AWS Credentials

public AmazonS3Client(AWSCredentials credentials)

Parameters

credentials AWSCredentials

AWS Credentials

AmazonS3Client(AWSCredentials, RegionEndpoint)

Constructs AmazonS3Client with AWS Credentials

public AmazonS3Client(AWSCredentials credentials, RegionEndpoint region)

Parameters

credentials AWSCredentials

AWS Credentials

region RegionEndpoint

The region to connect.

AmazonS3Client(AWSCredentials, AmazonS3Config)

Constructs AmazonS3Client with AWS Credentials and an AmazonS3Client Configuration object.

public AmazonS3Client(AWSCredentials credentials, AmazonS3Config clientConfig)

Parameters

credentials AWSCredentials

AWS Credentials

clientConfig AmazonS3Config

The AmazonS3Client Configuration Object

AmazonS3Client(AmazonS3Config)

Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3Client(AmazonS3Config config)

Parameters

config AmazonS3Config

The AmazonS3Client Configuration Object

AmazonS3Client(string, string)

Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

AmazonS3Client(string, string, RegionEndpoint)

Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

region RegionEndpoint

The region to connect.

AmazonS3Client(string, string, AmazonS3Config)

Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object.

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3Config clientConfig)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

clientConfig AmazonS3Config

The AmazonS3Client Configuration Object

AmazonS3Client(string, string, string)

Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

AmazonS3Client(string, string, string, RegionEndpoint)

Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

region RegionEndpoint

The region to connect.

AmazonS3Client(string, string, string, AmazonS3Config)

Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object.

public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3Config clientConfig)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

clientConfig AmazonS3Config

The AmazonS3Client Configuration Object

Properties

Paginators

Paginators for the service

public IS3PaginatorFactory Paginators { get; }

Property Value

IS3PaginatorFactory

ServiceMetadata

Capture metadata for the service.

protected override IServiceMetadata ServiceMetadata { get; }

Property Value

IServiceMetadata

Methods

AbortMultipartUploadAsync(AbortMultipartUploadRequest, CancellationToken)

This operation 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 operation and ensure that the parts list is empty.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

AbortMultipartUpload

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• ListMultipartUploads

public virtual Task<AbortMultipartUploadResponse> AbortMultipartUploadAsync(AbortMultipartUploadRequest request, CancellationToken cancellationToken = default)

Parameters

request AbortMultipartUploadRequest

Container for the necessary parameters to execute the AbortMultipartUpload service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<AbortMultipartUploadResponse>

The response from the AbortMultipartUpload service method, as returned by S3.

See Also

REST API Reference for AbortMultipartUpload Operation

AbortMultipartUploadAsync(string, string, string, CancellationToken)

This operation 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 operation and ensure that the parts list is empty.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

AbortMultipartUpload

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• ListMultipartUploads

public virtual Task<AbortMultipartUploadResponse> AbortMultipartUploadAsync(string bucketName, string key, string uploadId, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name to which the upload was taking place. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

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

uploadId string

Upload ID that identifies the multipart upload.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<AbortMultipartUploadResponse>

The response from the AbortMultipartUpload service method, as returned by S3.

See Also

REST API Reference for AbortMultipartUpload Operation

CompleteMultipartUploadAsync(CompleteMultipartUploadRequest, CancellationToken)

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation 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 operation 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.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

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

• UploadPart

• AbortMultipartUpload

• ListParts

• ListMultipartUploads

public virtual Task<CompleteMultipartUploadResponse> CompleteMultipartUploadAsync(CompleteMultipartUploadRequest request, CancellationToken cancellationToken = default)

Parameters

request CompleteMultipartUploadRequest

Container for the necessary parameters to execute the CompleteMultipartUpload service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CompleteMultipartUploadResponse>

The response from the CompleteMultipartUpload service method, as returned by S3.

See Also

REST API Reference for CompleteMultipartUpload Operation

CopyObjectAsync(CopyObjectRequest, CancellationToken)

Creates a copy of an object that is already stored in Amazon S3.

note

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 operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

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. 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 operation 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.

note

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.

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.

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.

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 in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

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

note

All headers with the

x-amz-

prefix, including

x-amz-copy-source

, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using 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.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.

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 AWS 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 and Managing ACLs Using the REST API.

Storage Class Options

You can use the

CopyObject

operation 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 in the Amazon S3 Service Developer 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.

The following operations are related to

CopyObject

:

• PutObject

• GetObject

For more information, see Copying Objects.

public virtual Task<CopyObjectResponse> CopyObjectAsync(CopyObjectRequest request, CancellationToken cancellationToken = default)

Parameters

request CopyObjectRequest

Container for the necessary parameters to execute the CopyObject service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CopyObjectResponse>

The response from the CopyObject service method, as returned by S3.

See Also

REST API Reference for CopyObject Operation

CopyObjectAsync(string, string, string, string, string, CancellationToken)

Creates a copy of an object that is already stored in Amazon S3.

note

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 operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

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. 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 operation 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.

note

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.

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.

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.

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 in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

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

note

All headers with the

x-amz-

prefix, including

x-amz-copy-source

, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using 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.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.

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 AWS 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 and Managing ACLs Using the REST API.

Storage Class Options

You can use the

CopyObject

operation 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 in the Amazon S3 Service Developer 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.

The following operations are related to

CopyObject

:

• PutObject

• GetObject

For more information, see Copying Objects.

public virtual Task<CopyObjectResponse> CopyObjectAsync(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, CancellationToken cancellationToken = default)

Parameters

sourceBucket string

A property of CopyObjectRequest used to execute the CopyObject service method.

sourceKey string

A property of CopyObjectRequest used to execute the CopyObject service method.

sourceVersionId string

A property of CopyObjectRequest used to execute the CopyObject service method.

destinationBucket string

A property of CopyObjectRequest used to execute the CopyObject service method.

destinationKey string

A property of CopyObjectRequest used to execute the CopyObject service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CopyObjectResponse>

The response from the CopyObject service method, as returned by S3.

See Also

REST API Reference for CopyObject Operation

CopyObjectAsync(string, string, string, string, CancellationToken)

Creates a copy of an object that is already stored in Amazon S3.

note

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 operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

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. 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 operation 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.

note

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.

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.

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.

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 in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

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

note

All headers with the

x-amz-

prefix, including

x-amz-copy-source

, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using 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.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.

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 AWS 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 and Managing ACLs Using the REST API.

Storage Class Options

You can use the

CopyObject

operation 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 in the Amazon S3 Service Developer 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.

The following operations are related to

CopyObject

:

• PutObject

• GetObject

For more information, see Copying Objects.

public virtual Task<CopyObjectResponse> CopyObjectAsync(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, CancellationToken cancellationToken = default)

Parameters

sourceBucket string

A property of CopyObjectRequest used to execute the CopyObject service method.

sourceKey string

A property of CopyObjectRequest used to execute the CopyObject service method.

destinationBucket string

A property of CopyObjectRequest used to execute the CopyObject service method.

destinationKey string

A property of CopyObjectRequest used to execute the CopyObject service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CopyObjectResponse>

The response from the CopyObject service method, as returned by S3.

See Also

REST API Reference for CopyObject Operation

CopyPartAsync(CopyPartRequest, CancellationToken)

public virtual Task<CopyPartResponse> CopyPartAsync(CopyPartRequest request, CancellationToken cancellationToken = default)

Parameters

request CopyPartRequest

cancellationToken CancellationToken

Returns

Task<CopyPartResponse>

CopyPartAsync(string, string, string, string, string, string, CancellationToken)

public virtual Task<CopyPartResponse> CopyPartAsync(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, string uploadId, CancellationToken cancellationToken = default)

Parameters

sourceBucket string

sourceKey string

sourceVersionId string

destinationBucket string

destinationKey string

uploadId string

cancellationToken CancellationToken

Returns

Task<CopyPartResponse>

CopyPartAsync(string, string, string, string, string, CancellationToken)

public virtual Task<CopyPartResponse> CopyPartAsync(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, string uploadId, CancellationToken cancellationToken = default)

Parameters

sourceBucket string

sourceKey string

destinationBucket string

destinationKey string

uploadId string

cancellationToken CancellationToken

Returns

Task<CopyPartResponse>

CreateSigner()

Creates the signer for the service.

protected override AbstractAWSSigner CreateSigner()

Returns

AbstractAWSSigner

CustomizeRuntimePipeline(RuntimePipeline)

Customizes the runtime pipeline.

protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)

Parameters

pipeline RuntimePipeline

Runtime pipeline for the current client.

DeleteBucketAnalyticsConfigurationAsync(DeleteBucketAnalyticsConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to

DeleteBucketAnalyticsConfiguration

:

• GetBucketAnalyticsConfiguration

• ListBucketAnalyticsConfigurations

• PutBucketAnalyticsConfiguration

public virtual Task<DeleteBucketAnalyticsConfigurationResponse> DeleteBucketAnalyticsConfigurationAsync(DeleteBucketAnalyticsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketAnalyticsConfigurationRequest

Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketAnalyticsConfigurationResponse>

The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3.

See Also

REST API Reference for DeleteBucketAnalyticsConfiguration Operation

DeleteBucketAsync(DeleteBucketRequest, CancellationToken)

public virtual Task<DeleteBucketResponse> DeleteBucketAsync(DeleteBucketRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketRequest

cancellationToken CancellationToken

Returns

Task<DeleteBucketResponse>

DeleteBucketAsync(string, CancellationToken)

public virtual Task<DeleteBucketResponse> DeleteBucketAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

cancellationToken CancellationToken

Returns

Task<DeleteBucketResponse>

DeleteBucketEncryptionAsync(DeleteBucketEncryptionRequest, CancellationToken)

public virtual Task<DeleteBucketEncryptionResponse> DeleteBucketEncryptionAsync(DeleteBucketEncryptionRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketEncryptionRequest

cancellationToken CancellationToken

Returns

Task<DeleteBucketEncryptionResponse>

DeleteBucketInventoryConfigurationAsync(DeleteBucketInventoryConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to

DeleteBucketInventoryConfiguration

include:

• GetBucketInventoryConfiguration

• PutBucketInventoryConfiguration

• ListBucketInventoryConfigurations

public virtual Task<DeleteBucketInventoryConfigurationResponse> DeleteBucketInventoryConfigurationAsync(DeleteBucketInventoryConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketInventoryConfigurationRequest

Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketInventoryConfigurationResponse>

The response from the DeleteBucketInventoryConfiguration service method, as returned by S3.

See Also

REST API Reference for DeleteBucketInventoryConfiguration Operation

DeleteBucketMetricsConfigurationAsync(DeleteBucketMetricsConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to

DeleteBucketMetricsConfiguration

:

• GetBucketMetricsConfiguration

• PutBucketMetricsConfiguration

• ListBucketMetricsConfigurations

• Monitoring Metrics with Amazon CloudWatch

public virtual Task<DeleteBucketMetricsConfigurationResponse> DeleteBucketMetricsConfigurationAsync(DeleteBucketMetricsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketMetricsConfigurationRequest

Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketMetricsConfigurationResponse>

The response from the DeleteBucketMetricsConfiguration service method, as returned by S3.

See Also

REST API Reference for DeleteBucketMetricsConfiguration Operation

DeleteBucketOwnershipControlsAsync(DeleteBucketOwnershipControlsRequest, CancellationToken)

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.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to

DeleteBucketOwnershipControls

:

• GetBucketOwnershipControls

• PutBucketOwnershipControls

public virtual Task<DeleteBucketOwnershipControlsResponse> DeleteBucketOwnershipControlsAsync(DeleteBucketOwnershipControlsRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketOwnershipControlsRequest

Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketOwnershipControlsResponse>

The response from the DeleteBucketOwnershipControls service method, as returned by S3.

See Also

REST API Reference for DeleteBucketOwnershipControls Operation

DeleteBucketPolicyAsync(DeleteBucketPolicyRequest, CancellationToken)

This implementation of the DELETE operation 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 AWS 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 AWS 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.

The following operations are related to

DeleteBucketPolicy

• CreateBucket

• DeleteObject

public virtual Task<DeleteBucketPolicyResponse> DeleteBucketPolicyAsync(DeleteBucketPolicyRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketPolicyRequest

Container for the necessary parameters to execute the DeleteBucketPolicy service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketPolicyResponse>

The response from the DeleteBucketPolicy service method, as returned by S3.

See Also

REST API Reference for DeleteBucketPolicy Operation

DeleteBucketPolicyAsync(string, CancellationToken)

This implementation of the DELETE operation 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 AWS 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 AWS 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.

The following operations are related to

DeleteBucketPolicy

• CreateBucket

• DeleteObject

public virtual Task<DeleteBucketPolicyResponse> DeleteBucketPolicyAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketPolicyResponse>

The response from the DeleteBucketPolicy service method, as returned by S3.

See Also

REST API Reference for DeleteBucketPolicy Operation

DeleteBucketReplicationAsync(DeleteBucketReplicationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

note

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 Developer Guide.

The following operations are related to

DeleteBucketReplication

:

• PutBucketReplication

• GetBucketReplication

public virtual Task<DeleteBucketReplicationResponse> DeleteBucketReplicationAsync(DeleteBucketReplicationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketReplicationRequest

Container for the necessary parameters to execute the DeleteBucketReplication service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketReplicationResponse>

The response from the DeleteBucketReplication service method, as returned by S3.

See Also

REST API Reference for DeleteBucketReplication Operation

DeleteBucketTaggingAsync(DeleteBucketTaggingRequest, CancellationToken)

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

• PutBucketTagging

public virtual Task<DeleteBucketTaggingResponse> DeleteBucketTaggingAsync(DeleteBucketTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketTaggingRequest

Container for the necessary parameters to execute the DeleteBucketTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketTaggingResponse>

The response from the DeleteBucketTagging service method, as returned by S3.

See Also

REST API Reference for DeleteBucketTagging Operation

DeleteBucketTaggingAsync(string, CancellationToken)

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

• PutBucketTagging

public virtual Task<DeleteBucketTaggingResponse> DeleteBucketTaggingAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket that has the tag set to be removed.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketTaggingResponse>

The response from the DeleteBucketTagging service method, as returned by S3.

See Also

REST API Reference for DeleteBucketTagging Operation

DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest, CancellationToken)

This operation 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 operation 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.

The following operations are related to

DeleteBucketWebsite

:

• GetBucketWebsite

• PutBucketWebsite

public virtual Task<DeleteBucketWebsiteResponse> DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBucketWebsiteRequest

Container for the necessary parameters to execute the DeleteBucketWebsite service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketWebsiteResponse>

The response from the DeleteBucketWebsite service method, as returned by S3.

See Also

REST API Reference for DeleteBucketWebsite Operation

DeleteBucketWebsiteAsync(string, CancellationToken)

This operation 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 operation 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.

The following operations are related to

DeleteBucketWebsite

:

• GetBucketWebsite

• PutBucketWebsite

public virtual Task<DeleteBucketWebsiteResponse> DeleteBucketWebsiteAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBucketWebsiteResponse>

The response from the DeleteBucketWebsite service method, as returned by S3.

See Also

REST API Reference for DeleteBucketWebsite Operation

DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest, CancellationToken)

public virtual Task<DeleteCORSConfigurationResponse> DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteCORSConfigurationRequest

cancellationToken CancellationToken

Returns

Task<DeleteCORSConfigurationResponse>

DeleteCORSConfigurationAsync(string, CancellationToken)

public virtual Task<DeleteCORSConfigurationResponse> DeleteCORSConfigurationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

cancellationToken CancellationToken

Returns

Task<DeleteCORSConfigurationResponse>

DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest, CancellationToken)

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.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

public virtual Task<DeleteLifecycleConfigurationResponse> DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteLifecycleConfigurationRequest

Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteLifecycleConfigurationResponse>

The response from the DeleteLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for DeleteLifecycleConfiguration Operation

DeleteLifecycleConfigurationAsync(string, CancellationToken)

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.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

public virtual Task<DeleteLifecycleConfigurationResponse> DeleteLifecycleConfigurationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name of the lifecycle to delete.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteLifecycleConfigurationResponse>

The response from the DeleteLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for DeleteLifecycleConfiguration Operation

DeleteObjectAsync(DeleteObjectRequest, CancellationToken)

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.

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. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) 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 operation is related to

DeleteObject

:

• PutObject

public virtual Task<DeleteObjectResponse> DeleteObjectAsync(DeleteObjectRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteObjectRequest

Container for the necessary parameters to execute the DeleteObject service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteObjectResponse>

The response from the DeleteObject service method, as returned by S3.

See Also

REST API Reference for DeleteObject Operation

DeleteObjectAsync(string, string, string, CancellationToken)

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.

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. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) 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 operation is related to

DeleteObject

:

• PutObject

public virtual Task<DeleteObjectResponse> DeleteObjectAsync(string bucketName, string key, string versionId, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name of the bucket containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

Key name of the object to delete.

versionId string

VersionId used to reference a specific version of the object.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteObjectResponse>

The response from the DeleteObject service method, as returned by S3.

See Also

REST API Reference for DeleteObject Operation

DeleteObjectAsync(string, string, CancellationToken)

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.

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. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) 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 operation is related to

DeleteObject

:

• PutObject

public virtual Task<DeleteObjectResponse> DeleteObjectAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name of the bucket containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

Key name of the object to delete.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteObjectResponse>

The response from the DeleteObject service method, as returned by S3.

See Also

REST API Reference for DeleteObject Operation

DeleteObjectTaggingAsync(DeleteObjectTaggingRequest, CancellationToken)

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

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

• GetObjectTagging

public virtual Task<DeleteObjectTaggingResponse> DeleteObjectTaggingAsync(DeleteObjectTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteObjectTaggingRequest

Container for the necessary parameters to execute the DeleteObjectTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteObjectTaggingResponse>

The response from the DeleteObjectTagging service method, as returned by S3.

See Also

REST API Reference for DeleteObjectTagging Operation

DeleteObjectsAsync(DeleteObjectsRequest, CancellationToken)

This operation 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 operation 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 operation 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 operation supports two modes for the response: verbose and quiet. By default, the operation 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 operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.

When performing this operation 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.

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

• UploadPart

• CompleteMultipartUpload

• ListParts

• AbortMultipartUpload

public virtual Task<DeleteObjectsResponse> DeleteObjectsAsync(DeleteObjectsRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteObjectsRequest

Container for the necessary parameters to execute the DeleteObjects service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteObjectsResponse>

The response from the DeleteObjects service method, as returned by S3.

See Also

REST API Reference for DeleteObjects Operation

DeletePublicAccessBlockAsync(DeletePublicAccessBlockRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to

DeletePublicAccessBlock

:

• Using Amazon S3 Block Public Access

• GetPublicAccessBlock

• PutPublicAccessBlock

• GetBucketPolicyStatus

public virtual Task<DeletePublicAccessBlockResponse> DeletePublicAccessBlockAsync(DeletePublicAccessBlockRequest request, CancellationToken cancellationToken = default)

Parameters

request DeletePublicAccessBlockRequest

Container for the necessary parameters to execute the DeletePublicAccessBlock service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeletePublicAccessBlockResponse>

The response from the DeletePublicAccessBlock service method, as returned by S3.

See Also

REST API Reference for DeletePublicAccessBlock Operation

Dispose(bool)

Disposes the service client.

protected override void Dispose(bool disposing)

Parameters

disposing bool

GetACLAsync(GetACLRequest, CancellationToken)

public virtual Task<GetACLResponse> GetACLAsync(GetACLRequest request, CancellationToken cancellationToken = default)

Parameters

request GetACLRequest

cancellationToken CancellationToken

Returns

Task<GetACLResponse>

GetACLAsync(string, CancellationToken)

public virtual Task<GetACLResponse> GetACLAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

cancellationToken CancellationToken

Returns

Task<GetACLResponse>

GetBucketAccelerateConfigurationAsync(GetBucketAccelerateConfigurationRequest, CancellationToken)

public virtual Task<GetBucketAccelerateConfigurationResponse> GetBucketAccelerateConfigurationAsync(GetBucketAccelerateConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketAccelerateConfigurationRequest

cancellationToken CancellationToken

Returns

Task<GetBucketAccelerateConfigurationResponse>

GetBucketAccelerateConfigurationAsync(string, CancellationToken)

public virtual Task<GetBucketAccelerateConfigurationResponse> GetBucketAccelerateConfigurationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

cancellationToken CancellationToken

Returns

Task<GetBucketAccelerateConfigurationResponse>

GetBucketAnalyticsConfigurationAsync(GetBucketAnalyticsConfigurationRequest, CancellationToken)

public virtual Task<GetBucketAnalyticsConfigurationResponse> GetBucketAnalyticsConfigurationAsync(GetBucketAnalyticsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketAnalyticsConfigurationRequest

cancellationToken CancellationToken

Returns

Task<GetBucketAnalyticsConfigurationResponse>

GetBucketEncryptionAsync(GetBucketEncryptionRequest, CancellationToken)

Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

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 and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to

GetBucketEncryption

:

• PutBucketEncryption

• DeleteBucketEncryption

public virtual Task<GetBucketEncryptionResponse> GetBucketEncryptionAsync(GetBucketEncryptionRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketEncryptionRequest

Container for the necessary parameters to execute the GetBucketEncryption service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketEncryptionResponse>

The response from the GetBucketEncryption service method, as returned by S3.

See Also

REST API Reference for GetBucketEncryption Operation

GetBucketInventoryConfigurationAsync(GetBucketInventoryConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to

GetBucketInventoryConfiguration

:

• DeleteBucketInventoryConfiguration

• ListBucketInventoryConfigurations

• PutBucketInventoryConfiguration

public virtual Task<GetBucketInventoryConfigurationResponse> GetBucketInventoryConfigurationAsync(GetBucketInventoryConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketInventoryConfigurationRequest

Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketInventoryConfigurationResponse>

The response from the GetBucketInventoryConfiguration service method, as returned by S3.

See Also

REST API Reference for GetBucketInventoryConfiguration Operation

GetBucketLocationAsync(GetBucketLocationRequest, CancellationToken)

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.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to

GetBucketLocation

:

• GetObject

• CreateBucket

public virtual Task<GetBucketLocationResponse> GetBucketLocationAsync(GetBucketLocationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketLocationRequest

Container for the necessary parameters to execute the GetBucketLocation service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketLocationResponse>

The response from the GetBucketLocation service method, as returned by S3.

See Also

REST API Reference for GetBucketLocation Operation

GetBucketLocationAsync(string, CancellationToken)

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.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to

GetBucketLocation

:

• GetObject

• CreateBucket

public virtual Task<GetBucketLocationResponse> GetBucketLocationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketLocationResponse>

The response from the GetBucketLocation service method, as returned by S3.

See Also

REST API Reference for GetBucketLocation Operation

GetBucketLoggingAsync(GetBucketLoggingRequest, CancellationToken)

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

• PutBucketLogging

public virtual Task<GetBucketLoggingResponse> GetBucketLoggingAsync(GetBucketLoggingRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketLoggingRequest

Container for the necessary parameters to execute the GetBucketLogging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketLoggingResponse>

The response from the GetBucketLogging service method, as returned by S3.

See Also

REST API Reference for GetBucketLogging Operation

GetBucketLoggingAsync(string, CancellationToken)

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

• PutBucketLogging

public virtual Task<GetBucketLoggingResponse> GetBucketLoggingAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name for which to get the logging information.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketLoggingResponse>

The response from the GetBucketLogging service method, as returned by S3.

See Also

REST API Reference for GetBucketLogging Operation

GetBucketMetricsConfigurationAsync(GetBucketMetricsConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to

GetBucketMetricsConfiguration

:

• PutBucketMetricsConfiguration

• DeleteBucketMetricsConfiguration

• ListBucketMetricsConfigurations

• Monitoring Metrics with Amazon CloudWatch

public virtual Task<GetBucketMetricsConfigurationResponse> GetBucketMetricsConfigurationAsync(GetBucketMetricsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketMetricsConfigurationRequest

Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketMetricsConfigurationResponse>

The response from the GetBucketMetricsConfiguration service method, as returned by S3.

See Also

REST API Reference for GetBucketMetricsConfiguration Operation

GetBucketNotificationAsync(GetBucketNotificationRequest, CancellationToken)

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the operation 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. For more information about bucket policies, see Using Bucket Policies.

The following operation is related to

GetBucketNotification

:

• PutBucketNotification

public virtual Task<GetBucketNotificationResponse> GetBucketNotificationAsync(GetBucketNotificationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketNotificationRequest

Container for the necessary parameters to execute the GetBucketNotification service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketNotificationResponse>

The response from the GetBucketNotification service method, as returned by S3.

See Also

REST API Reference for GetBucketNotification Operation

GetBucketNotificationAsync(string, CancellationToken)

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the operation 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. For more information about bucket policies, see Using Bucket Policies.

The following operation is related to

GetBucketNotification

:

• PutBucketNotification

public virtual Task<GetBucketNotificationResponse> GetBucketNotificationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketNotificationResponse>

The response from the GetBucketNotification service method, as returned by S3.

See Also

REST API Reference for GetBucketNotification Operation

GetBucketOwnershipControlsAsync(GetBucketOwnershipControlsRequest, CancellationToken)

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.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to

GetBucketOwnershipControls

:

• PutBucketOwnershipControls

• DeleteBucketOwnershipControls

public virtual Task<GetBucketOwnershipControlsResponse> GetBucketOwnershipControlsAsync(GetBucketOwnershipControlsRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketOwnershipControlsRequest

Container for the necessary parameters to execute the GetBucketOwnershipControls service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketOwnershipControlsResponse>

The response from the GetBucketOwnershipControls service method, as returned by S3.

See Also

REST API Reference for GetBucketOwnershipControls Operation

GetBucketPolicyAsync(GetBucketPolicyRequest, CancellationToken)

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS 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 AWS 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.

The following operation is related to

GetBucketPolicy

:

• GetObject

public virtual Task<GetBucketPolicyResponse> GetBucketPolicyAsync(GetBucketPolicyRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketPolicyRequest

Container for the necessary parameters to execute the GetBucketPolicy service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketPolicyResponse>

The response from the GetBucketPolicy service method, as returned by S3.

See Also

REST API Reference for GetBucketPolicy Operation

GetBucketPolicyAsync(string, CancellationToken)

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS 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 AWS 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.

The following operation is related to

GetBucketPolicy

:

• GetObject

public virtual Task<GetBucketPolicyResponse> GetBucketPolicyAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name for which to get the bucket policy.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketPolicyResponse>

The response from the GetBucketPolicy service method, as returned by S3.

See Also

REST API Reference for GetBucketPolicy Operation

GetBucketPolicyStatusAsync(GetBucketPolicyStatusRequest, CancellationToken)

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.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to

GetBucketPolicyStatus

:

• Using Amazon S3 Block Public Access

• GetPublicAccessBlock

• PutPublicAccessBlock

• DeletePublicAccessBlock

public virtual Task<GetBucketPolicyStatusResponse> GetBucketPolicyStatusAsync(GetBucketPolicyStatusRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketPolicyStatusRequest

Container for the necessary parameters to execute the GetBucketPolicyStatus service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketPolicyStatusResponse>

The response from the GetBucketPolicyStatus service method, as returned by S3.

See Also

REST API Reference for GetBucketPolicyStatus Operation

GetBucketReplicationAsync(GetBucketReplicationRequest, CancellationToken)

Retrieves the replication configuration for the given Amazon S3 bucket.

public virtual Task<GetBucketReplicationResponse> GetBucketReplicationAsync(GetBucketReplicationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketReplicationRequest

Container for the necessary parameters to execute the GetBucketReplication service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketReplicationResponse>

The response from the GetBucketReplication service method, as returned by S3.

See Also

REST API Reference for GetBucketReplication Operation

GetBucketRequestPaymentAsync(GetBucketRequestPaymentRequest, CancellationToken)

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.

The following operations are related to

GetBucketRequestPayment

:

• ListObjects

public virtual Task<GetBucketRequestPaymentResponse> GetBucketRequestPaymentAsync(GetBucketRequestPaymentRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketRequestPaymentRequest

Container for the necessary parameters to execute the GetBucketRequestPayment service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketRequestPaymentResponse>

The response from the GetBucketRequestPayment service method, as returned by S3.

See Also

REST API Reference for GetBucketRequestPayment Operation

GetBucketRequestPaymentAsync(string, CancellationToken)

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.

The following operations are related to

GetBucketRequestPayment

:

• ListObjects

public virtual Task<GetBucketRequestPaymentResponse> GetBucketRequestPaymentAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketRequestPaymentResponse>

The response from the GetBucketRequestPayment service method, as returned by S3.

See Also

REST API Reference for GetBucketRequestPayment Operation

GetBucketTaggingAsync(GetBucketTaggingRequest, CancellationToken)

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:

  NoSuchTagSetError

  • Description: There is no tag set associated with the bucket.

The following operations are related to

GetBucketTagging

:

• PutBucketTagging

• DeleteBucketTagging

public virtual Task<GetBucketTaggingResponse> GetBucketTaggingAsync(GetBucketTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketTaggingRequest

Container for the necessary parameters to execute the GetBucketTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketTaggingResponse>

The response from the GetBucketTagging service method, as returned by S3.

See Also

REST API Reference for GetBucketTagging Operation

GetBucketVersioningAsync(GetBucketVersioningRequest, CancellationToken)

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

• PutObject

• DeleteObject

public virtual Task<GetBucketVersioningResponse> GetBucketVersioningAsync(GetBucketVersioningRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketVersioningRequest

Container for the necessary parameters to execute the GetBucketVersioning service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketVersioningResponse>

The response from the GetBucketVersioning service method, as returned by S3.

See Also

REST API Reference for GetBucketVersioning Operation

GetBucketVersioningAsync(string, CancellationToken)

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

• PutObject

• DeleteObject

public virtual Task<GetBucketVersioningResponse> GetBucketVersioningAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketVersioningResponse>

The response from the GetBucketVersioning service method, as returned by S3.

See Also

REST API Reference for GetBucketVersioning Operation

GetBucketWebsiteAsync(GetBucketWebsiteRequest, CancellationToken)

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.

This GET operation 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

• PutBucketWebsite

public virtual Task<GetBucketWebsiteResponse> GetBucketWebsiteAsync(GetBucketWebsiteRequest request, CancellationToken cancellationToken = default)

Parameters

request GetBucketWebsiteRequest

Container for the necessary parameters to execute the GetBucketWebsite service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketWebsiteResponse>

The response from the GetBucketWebsite service method, as returned by S3.

See Also

REST API Reference for GetBucketWebsite Operation

GetBucketWebsiteAsync(string, CancellationToken)

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.

This GET operation 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

• PutBucketWebsite

public virtual Task<GetBucketWebsiteResponse> GetBucketWebsiteAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name for which to get the website configuration.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetBucketWebsiteResponse>

The response from the GetBucketWebsite service method, as returned by S3.

See Also

REST API Reference for GetBucketWebsite Operation

GetCORSConfigurationAsync(GetCORSConfigurationRequest, CancellationToken)

Returns the 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.

The following operations are related to

GetBucketCors

:

• PutBucketCors

• DeleteBucketCors

public virtual Task<GetCORSConfigurationResponse> GetCORSConfigurationAsync(GetCORSConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetCORSConfigurationRequest

Container for the necessary parameters to execute the GetCORSConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetCORSConfigurationResponse>

The response from the GetCORSConfiguration service method, as returned by S3.

See Also

REST API Reference for GetCORSConfiguration Operation

GetCORSConfigurationAsync(string, CancellationToken)

Returns the 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.

The following operations are related to

GetBucketCors

:

• PutBucketCors

• DeleteBucketCors

public virtual Task<GetCORSConfigurationResponse> GetCORSConfigurationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name for which to get the cors configuration.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetCORSConfigurationResponse>

The response from the GetCORSConfiguration service method, as returned by S3.

See Also

REST API Reference for GetCORSConfiguration Operation

GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest, CancellationToken)

note

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 API description, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

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 and Managing Access Permissions to Your Amazon S3 Resources.

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

• PutBucketLifecycle

• DeleteBucketLifecycle

public virtual Task<GetLifecycleConfigurationResponse> GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetLifecycleConfigurationRequest

Container for the necessary parameters to execute the GetLifecycleConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetLifecycleConfigurationResponse>

The response from the GetLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for GetLifecycleConfiguration Operation

GetLifecycleConfigurationAsync(string, CancellationToken)

note

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 API description, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

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 and Managing Access Permissions to Your Amazon S3 Resources.

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

• PutBucketLifecycle

• DeleteBucketLifecycle

public virtual Task<GetLifecycleConfigurationResponse> GetLifecycleConfigurationAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetLifecycleConfigurationResponse>

The response from the GetLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for GetLifecycleConfiguration Operation

GetObjectAsync(GetObjectRequest, CancellationToken)

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.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an

InvalidObjectStateError

error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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).

Assuming you have permission to read object tags (permission for the

s3:GetObjectVersionTagging

action), 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 to retrieve the tag set associated with an object.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation returns the current version of an object. To return a different version, use the

versionId

subresource.

note

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.

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.

note

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.

The following operations are related to

GetObject

:

• ListBuckets

• GetObjectAcl

public virtual Task<GetObjectResponse> GetObjectAsync(GetObjectRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectRequest

Container for the necessary parameters to execute the GetObject service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectResponse>

The response from the GetObject service method, as returned by S3.

See Also

REST API Reference for GetObject Operation

GetObjectAsync(string, string, string, CancellationToken)

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.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an

InvalidObjectStateError

error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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).

Assuming you have permission to read object tags (permission for the

s3:GetObjectVersionTagging

action), 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 to retrieve the tag set associated with an object.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation returns the current version of an object. To return a different version, use the

versionId

subresource.

note

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.

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.

note

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.

The following operations are related to

GetObject

:

• ListBuckets

• GetObjectAcl

public virtual Task<GetObjectResponse> GetObjectAsync(string bucketName, string key, string versionId, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

Key of the object to get.

versionId string

VersionId used to reference a specific version of the object.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectResponse>

The response from the GetObject service method, as returned by S3.

See Also

REST API Reference for GetObject Operation

GetObjectAsync(string, string, CancellationToken)

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.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an

InvalidObjectStateError

error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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).

Assuming you have permission to read object tags (permission for the

s3:GetObjectVersionTagging

action), 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 to retrieve the tag set associated with an object.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation returns the current version of an object. To return a different version, use the

versionId

subresource.

note

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.

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.

note

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.

The following operations are related to

GetObject

:

• ListBuckets

• GetObjectAcl

public virtual Task<GetObjectResponse> GetObjectAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

Key of the object to get.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectResponse>

The response from the GetObject service method, as returned by S3.

See Also

REST API Reference for GetObject Operation

GetObjectLegalHoldAsync(GetObjectLegalHoldRequest, CancellationToken)

Gets an object's current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

public virtual Task<GetObjectLegalHoldResponse> GetObjectLegalHoldAsync(GetObjectLegalHoldRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectLegalHoldRequest

Container for the necessary parameters to execute the GetObjectLegalHold service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectLegalHoldResponse>

The response from the GetObjectLegalHold service method, as returned by S3.

See Also

REST API Reference for GetObjectLegalHold Operation

GetObjectLockConfigurationAsync(GetObjectLockConfigurationRequest, CancellationToken)

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.

public virtual Task<GetObjectLockConfigurationResponse> GetObjectLockConfigurationAsync(GetObjectLockConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectLockConfigurationRequest

Container for the necessary parameters to execute the GetObjectLockConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectLockConfigurationResponse>

The response from the GetObjectLockConfiguration service method, as returned by S3.

See Also

REST API Reference for GetObjectLockConfiguration Operation

GetObjectMetadataAsync(GetObjectMetadataRequest, CancellationToken)

The HEAD operation retrieves metadata from an object without returning the object itself. This operation 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

operation on an object. The response is identical to the

GET

response except that there is no response body.

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).

note

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

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.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation is related to

HeadObject

:

• GetObject

public virtual Task<GetObjectMetadataResponse> GetObjectMetadataAsync(GetObjectMetadataRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectMetadataRequest

Container for the necessary parameters to execute the GetObjectMetadata service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectMetadataResponse>

The response from the GetObjectMetadata service method, as returned by S3.

See Also

REST API Reference for GetObjectMetadata Operation

GetObjectMetadataAsync(string, string, string, CancellationToken)

The HEAD operation retrieves metadata from an object without returning the object itself. This operation 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

operation on an object. The response is identical to the

GET

response except that there is no response body.

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).

note

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

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.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation is related to

HeadObject

:

• GetObject

public virtual Task<GetObjectMetadataResponse> GetObjectMetadataAsync(string bucketName, string key, string versionId, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

The object key.

versionId string

VersionId used to reference a specific version of the object.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectMetadataResponse>

The response from the GetObjectMetadata service method, as returned by S3.

See Also

REST API Reference for GetObjectMetadata Operation

GetObjectMetadataAsync(string, string, CancellationToken)

The HEAD operation retrieves metadata from an object without returning the object itself. This operation 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

operation on an object. The response is identical to the

GET

response except that there is no response body.

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).

note

Encryption request headers, like

x-amz-server-side-encryption

, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (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.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

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.

Permissions

You need the

s3:GetObject

permission for this operation. For more information, see Specifying Permissions in a Policy. 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 operation is related to

HeadObject

:

• GetObject

public virtual Task<GetObjectMetadataResponse> GetObjectMetadataAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket containing the object. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

The object key.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectMetadataResponse>

The response from the GetObjectMetadata service method, as returned by S3.

See Also

REST API Reference for GetObjectMetadata Operation

GetObjectRetentionAsync(GetObjectRetentionRequest, CancellationToken)

Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

public virtual Task<GetObjectRetentionResponse> GetObjectRetentionAsync(GetObjectRetentionRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectRetentionRequest

Container for the necessary parameters to execute the GetObjectRetention service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectRetentionResponse>

The response from the GetObjectRetention service method, as returned by S3.

See Also

REST API Reference for GetObjectRetention Operation

GetObjectTaggingAsync(GetObjectTaggingRequest, CancellationToken)

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 operation 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.

The following operation is related to

GetObjectTagging

:

• PutObjectTagging

public virtual Task<GetObjectTaggingResponse> GetObjectTaggingAsync(GetObjectTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectTaggingRequest

Container for the necessary parameters to execute the GetObjectTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectTaggingResponse>

The response from the GetObjectTagging service method, as returned by S3.

See Also

REST API Reference for GetObjectTagging Operation

GetObjectTorrentAsync(GetObjectTorrentRequest, CancellationToken)

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.

note

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 operation is related to

GetObjectTorrent

:

• GetObject

public virtual Task<GetObjectTorrentResponse> GetObjectTorrentAsync(GetObjectTorrentRequest request, CancellationToken cancellationToken = default)

Parameters

request GetObjectTorrentRequest

Container for the necessary parameters to execute the GetObjectTorrent service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectTorrentResponse>

The response from the GetObjectTorrent service method, as returned by S3.

See Also

REST API Reference for GetObjectTorrent Operation

GetObjectTorrentAsync(string, string, CancellationToken)

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.

note

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 operation is related to

GetObjectTorrent

:

• GetObject

public virtual Task<GetObjectTorrentResponse> GetObjectTorrentAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

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

key string

The object key for which to get the information.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetObjectTorrentResponse>

The response from the GetObjectTorrent service method, as returned by S3.

See Also

REST API Reference for GetObjectTorrent Operation

GetPreSignedURL(GetPreSignedUrlRequest)

Create a signed URL allowing access to a resource that would usually require authentication.

public string GetPreSignedURL(GetPreSignedUrlRequest request)

Parameters

request GetPreSignedUrlRequest

The GetPreSignedUrlRequest that defines the parameters of the operation.

Returns

string

A string that is the signed http request.

Remarks

When using query string authentication you create a query, specify an expiration time for the query, sign it with your signature, place the data in an HTTP request, and distribute the request to a user or embed the request in a web page.

A PreSigned URL can be generated for GET, PUT, DELETE and HEAD operations on your bucketName, keys, and versions.

Exceptions

ArgumentException

ArgumentNullException

GetPublicAccessBlockAsync(GetPublicAccessBlockRequest, CancellationToken)

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.

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".

The following operations are related to

GetPublicAccessBlock

:

• Using Amazon S3 Block Public Access

• PutPublicAccessBlock

• GetPublicAccessBlock

• DeletePublicAccessBlock

public virtual Task<GetPublicAccessBlockResponse> GetPublicAccessBlockAsync(GetPublicAccessBlockRequest request, CancellationToken cancellationToken = default)

Parameters

request GetPublicAccessBlockRequest

Container for the necessary parameters to execute the GetPublicAccessBlock service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetPublicAccessBlockResponse>

The response from the GetPublicAccessBlock service method, as returned by S3.

See Also

REST API Reference for GetPublicAccessBlock Operation

Initialize()

Specialize the initialize of the client.

protected override void Initialize()

InitiateMultipartUploadAsync(InitiateMultipartUploadRequest, CancellationToken)

This operation 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). 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.

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 operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

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 (AWS Signature Version 4).

note

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 AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy 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 AWS KMS CMK, the requester must have permission to the

kms:Encrypt

,

kms:Decrypt

,

kms:ReEncrypt*

,

kms:GenerateDataKey*

, and

kms:DescribeKey

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.

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, 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.

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.

• 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.

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 AWS managed encryption keys or provide your own encryption key.

• Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS 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

  note

  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 AWS managed CMK in AWS KMS to protect the data.

  All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.

  For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

• 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 CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

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 AWS 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. 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.

• Specify access permissions explicitly — To explicitly grant access permissions to specific AWS 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. 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 AWS account

  • uri

    – if you are granting permissions to a predefined group

  • emailAddress

    – if the value specified is the email address of an AWS account

    note

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

  For example, the following

  x-amz-grant-read

  header grants the AWS 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

• CompleteMultipartUpload

• AbortMultipartUpload

• ListParts

• ListMultipartUploads

public virtual Task<InitiateMultipartUploadResponse> InitiateMultipartUploadAsync(InitiateMultipartUploadRequest request, CancellationToken cancellationToken = default)

Parameters

request InitiateMultipartUploadRequest

Container for the necessary parameters to execute the InitiateMultipartUpload service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<InitiateMultipartUploadResponse>

The response from the InitiateMultipartUpload service method, as returned by S3.

See Also

REST API Reference for InitiateMultipartUpload Operation

InitiateMultipartUploadAsync(string, string, CancellationToken)

This operation 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). 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.

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 operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

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 (AWS Signature Version 4).

note

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 AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy 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 AWS KMS CMK, the requester must have permission to the

kms:Encrypt

,

kms:Decrypt

,

kms:ReEncrypt*

,

kms:GenerateDataKey*

, and

kms:DescribeKey

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.

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, 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.

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.

• 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.

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 AWS managed encryption keys or provide your own encryption key.

• Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS 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

  note

  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 AWS managed CMK in AWS KMS to protect the data.

  All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.

  For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

• 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 CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

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 AWS 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. 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.

• Specify access permissions explicitly — To explicitly grant access permissions to specific AWS 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. 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 AWS account

  • uri

    – if you are granting permissions to a predefined group

  • emailAddress

    – if the value specified is the email address of an AWS account

    note

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

  For example, the following

  x-amz-grant-read

  header grants the AWS 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

• CompleteMultipartUpload

• AbortMultipartUpload

• ListParts

• ListMultipartUploads

public virtual Task<InitiateMultipartUploadResponse> InitiateMultipartUploadAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket to which to initiate the upload When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

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

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<InitiateMultipartUploadResponse>

The response from the InitiateMultipartUpload service method, as returned by S3.

See Also

REST API Reference for InitiateMultipartUpload Operation

ListBucketAnalyticsConfigurationsAsync(ListBucketAnalyticsConfigurationsRequest, CancellationToken)

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to

ListBucketAnalyticsConfigurations

:

• GetBucketAnalyticsConfiguration

• DeleteBucketAnalyticsConfiguration

• PutBucketAnalyticsConfiguration

public virtual Task<ListBucketAnalyticsConfigurationsResponse> ListBucketAnalyticsConfigurationsAsync(ListBucketAnalyticsConfigurationsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListBucketAnalyticsConfigurationsRequest

Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBucketAnalyticsConfigurationsResponse>

The response from the ListBucketAnalyticsConfigurations service method, as returned by S3.

See Also

REST API Reference for ListBucketAnalyticsConfigurations Operation

ListBucketInventoryConfigurationsAsync(ListBucketInventoryConfigurationsRequest, CancellationToken)

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation 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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to

ListBucketInventoryConfigurations

:

• GetBucketInventoryConfiguration

• DeleteBucketInventoryConfiguration

• PutBucketInventoryConfiguration

public virtual Task<ListBucketInventoryConfigurationsResponse> ListBucketInventoryConfigurationsAsync(ListBucketInventoryConfigurationsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListBucketInventoryConfigurationsRequest

Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBucketInventoryConfigurationsResponse>

The response from the ListBucketInventoryConfigurations service method, as returned by S3.

See Also

REST API Reference for ListBucketInventoryConfigurations Operation

ListBucketMetricsConfigurationsAsync(ListBucketMetricsConfigurationsRequest, CancellationToken)

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 operation 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 and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to

ListBucketMetricsConfigurations

:

• PutBucketMetricsConfiguration

• GetBucketMetricsConfiguration

• DeleteBucketMetricsConfiguration

public virtual Task<ListBucketMetricsConfigurationsResponse> ListBucketMetricsConfigurationsAsync(ListBucketMetricsConfigurationsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListBucketMetricsConfigurationsRequest

Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBucketMetricsConfigurationsResponse>

The response from the ListBucketMetricsConfigurations service method, as returned by S3.

See Also

REST API Reference for ListBucketMetricsConfigurations Operation

ListBucketsAsync(ListBucketsRequest, CancellationToken)

Returns a list of all buckets owned by the authenticated sender of the request.

public virtual Task<ListBucketsResponse> ListBucketsAsync(ListBucketsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListBucketsRequest

Container for the necessary parameters to execute the ListBuckets service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBucketsResponse>

The response from the ListBuckets service method, as returned by S3.

See Also

REST API Reference for ListBuckets Operation

ListBucketsAsync(CancellationToken)

Returns a list of all buckets owned by the authenticated sender of the request.

public virtual Task<ListBucketsResponse> ListBucketsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBucketsResponse>

The response from the ListBuckets service method, as returned by S3.

See Also

REST API Reference for ListBuckets Operation

ListMultipartUploadsAsync(ListMultipartUploadsRequest, CancellationToken)

This operation 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 operation 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.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

ListMultipartUploads

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• AbortMultipartUpload

public virtual Task<ListMultipartUploadsResponse> ListMultipartUploadsAsync(ListMultipartUploadsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListMultipartUploadsRequest

Container for the necessary parameters to execute the ListMultipartUploads service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListMultipartUploadsResponse>

The response from the ListMultipartUploads service method, as returned by S3.

See Also

REST API Reference for ListMultipartUploads Operation

ListMultipartUploadsAsync(string, string, CancellationToken)

This operation 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 operation 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.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

ListMultipartUploads

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• AbortMultipartUpload

public virtual Task<ListMultipartUploadsResponse> ListMultipartUploadsAsync(string bucketName, string prefix, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket to which the multipart upload was initiated. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

prefix string

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.)

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListMultipartUploadsResponse>

The response from the ListMultipartUploads service method, as returned by S3.

See Also

REST API Reference for ListMultipartUploads Operation

ListMultipartUploadsAsync(string, CancellationToken)

This operation 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 operation 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.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

ListMultipartUploads

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• AbortMultipartUpload

public virtual Task<ListMultipartUploadsResponse> ListMultipartUploadsAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket to which the multipart upload was initiated. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListMultipartUploadsResponse>

The response from the ListMultipartUploads service method, as returned by S3.

See Also

REST API Reference for ListMultipartUploads Operation

ListObjectsAsync(ListObjectsRequest, CancellationToken)

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 API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support

ListObjects

.

The following operations are related to

ListObjects

:

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

public virtual Task<ListObjectsResponse> ListObjectsAsync(ListObjectsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListObjectsRequest

Container for the necessary parameters to execute the ListObjects service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListObjectsResponse>

The response from the ListObjects service method, as returned by S3.

See Also

REST API Reference for ListObjects Operation

ListObjectsAsync(string, string, CancellationToken)

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 API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support

ListObjects

.

The following operations are related to

ListObjects

:

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

public virtual Task<ListObjectsResponse> ListObjectsAsync(string bucketName, string prefix, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket containing the objects. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

prefix string

Limits the response to keys that begin with the specified prefix.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListObjectsResponse>

The response from the ListObjects service method, as returned by S3.

See Also

REST API Reference for ListObjects Operation

ListObjectsAsync(string, CancellationToken)

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 API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support

ListObjects

.

The following operations are related to

ListObjects

:

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

public virtual Task<ListObjectsResponse> ListObjectsAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket containing the objects. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListObjectsResponse>

The response from the ListObjects service method, as returned by S3.

See Also

REST API Reference for ListObjects Operation

ListObjectsV2Async(ListObjectsV2Request, CancellationToken)

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. 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.

To use this operation in an AWS 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 and Managing Access Permissions to Your Amazon S3 Resources.

This section describes the latest revision of the API. 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.

To get a list of your buckets, see ListBuckets.

The following operations are related to

ListObjectsV2

:

• GetObject

• PutObject

• CreateBucket

public virtual Task<ListObjectsV2Response> ListObjectsV2Async(ListObjectsV2Request request, CancellationToken cancellationToken = default)

Parameters

request ListObjectsV2Request

Container for the necessary parameters to execute the ListObjectsV2 service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListObjectsV2Response>

The response from the ListObjectsV2 service method, as returned by S3.

See Also

REST API Reference for ListObjectsV2 Operation

ListPartsAsync(ListPartsRequest, CancellationToken)

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). 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.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

ListParts

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• AbortMultipartUpload

• ListMultipartUploads

public virtual Task<ListPartsResponse> ListPartsAsync(ListPartsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListPartsRequest

Container for the necessary parameters to execute the ListParts service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListPartsResponse>

The response from the ListParts service method, as returned by S3.

See Also

REST API Reference for ListParts Operation

ListPartsAsync(string, string, string, CancellationToken)

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). 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.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to

ListParts

:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• AbortMultipartUpload

• ListMultipartUploads

public virtual Task<ListPartsResponse> ListPartsAsync(string bucketName, string key, string uploadId, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket to which the parts are being uploaded. When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

key string

Object key for which the multipart upload was initiated.

uploadId string

Upload ID identifying the multipart upload whose parts are being listed.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListPartsResponse>

The response from the ListParts service method, as returned by S3.

See Also

REST API Reference for ListParts Operation

ListVersionsAsync(ListVersionsRequest, CancellationToken)

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.

note

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

• GetObject

• PutObject

• DeleteObject

public virtual Task<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListVersionsRequest

Container for the necessary parameters to execute the ListVersions service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListVersionsResponse>

The response from the ListVersions service method, as returned by S3.

See Also

REST API Reference for ListVersions Operation

ListVersionsAsync(string, string, CancellationToken)

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.

note

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

• GetObject

• PutObject

• DeleteObject

public virtual Task<ListVersionsResponse> ListVersionsAsync(string bucketName, string prefix, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name that contains the objects.

prefix string

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.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListVersionsResponse>

The response from the ListVersions service method, as returned by S3.

See Also

REST API Reference for ListVersions Operation

ListVersionsAsync(string, CancellationToken)

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.

note

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

• GetObject

• PutObject

• DeleteObject

public virtual Task<ListVersionsResponse> ListVersionsAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name that contains the objects.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListVersionsResponse>

The response from the ListVersions service method, as returned by S3.

See Also

REST API Reference for ListVersions Operation

PutACLAsync(PutACLRequest, CancellationToken)

public virtual Task<PutACLResponse> PutACLAsync(PutACLRequest request, CancellationToken cancellationToken = default)

Parameters

request PutACLRequest

cancellationToken CancellationToken

Returns

Task<PutACLResponse>

PutBucketAccelerateConfigurationAsync(PutBucketAccelerateConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

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 operation 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.

The following operations are related to

PutBucketAccelerateConfiguration

:

• GetBucketAccelerateConfiguration

• CreateBucket

public virtual Task<PutBucketAccelerateConfigurationResponse> PutBucketAccelerateConfigurationAsync(PutBucketAccelerateConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketAccelerateConfigurationRequest

Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketAccelerateConfigurationResponse>

The response from the PutBucketAccelerateConfiguration service method, as returned by S3.

See Also

REST API Reference for PutBucketAccelerateConfiguration Operation

PutBucketAnalyticsConfigurationAsync(PutBucketAnalyticsConfigurationRequest, CancellationToken)

public virtual Task<PutBucketAnalyticsConfigurationResponse> PutBucketAnalyticsConfigurationAsync(PutBucketAnalyticsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketAnalyticsConfigurationRequest

cancellationToken CancellationToken

Returns

Task<PutBucketAnalyticsConfigurationResponse>

PutBucketAsync(PutBucketRequest, CancellationToken)

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS 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 Working with Amazon S3 buckets.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

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.

note

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.

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. 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.

• 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.

  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 AWS account

  • uri

    – if you are granting permissions to a predefined group

  • emailAddress

    – if the value specified is the email address of an AWS account

    note

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

  For example, the following

  x-amz-grant-read

  header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

  x-amz-grant-read: id="11112222333", id="444455556666"

note

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

The following operations are related to

CreateBucket

:

• PutObject

• DeleteBucket

public virtual Task<PutBucketResponse> PutBucketAsync(PutBucketRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketRequest

Container for the necessary parameters to execute the PutBucket service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketResponse>

The response from the PutBucket service method, as returned by S3.

See Also

REST API Reference for PutBucket Operation

PutBucketAsync(string, CancellationToken)

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS 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 Working with Amazon S3 buckets.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

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.

note

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.

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. 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.

• 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.

  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 AWS account

  • uri

    – if you are granting permissions to a predefined group

  • emailAddress

    – if the value specified is the email address of an AWS account

    note

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

  For example, the following

  x-amz-grant-read

  header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

  x-amz-grant-read: id="11112222333", id="444455556666"

note

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

The following operations are related to

CreateBucket

:

• PutObject

• DeleteBucket

public virtual Task<PutBucketResponse> PutBucketAsync(string bucketName, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket to create.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketResponse>

The response from the PutBucket service method, as returned by S3.

See Also

REST API Reference for PutBucket Operation

PutBucketEncryptionAsync(PutBucketEncryptionRequest, CancellationToken)

public virtual Task<PutBucketEncryptionResponse> PutBucketEncryptionAsync(PutBucketEncryptionRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketEncryptionRequest

cancellationToken CancellationToken

Returns

Task<PutBucketEncryptionResponse>

PutBucketInventoryConfigurationAsync(PutBucketInventoryConfigurationRequest, CancellationToken)

public virtual Task<PutBucketInventoryConfigurationResponse> PutBucketInventoryConfigurationAsync(PutBucketInventoryConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketInventoryConfigurationRequest

cancellationToken CancellationToken

Returns

Task<PutBucketInventoryConfigurationResponse>

PutBucketLoggingAsync(PutBucketLoggingRequest, CancellationToken)

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 AWS 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.

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:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
                     </Grantee>

  DisplayName is optional and ignored in the request.

• By Email address:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>

  The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

• By URI:

  <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to

PutBucketLogging

:

• PutObject

• DeleteBucket

• CreateBucket

• GetBucketLogging

public virtual Task<PutBucketLoggingResponse> PutBucketLoggingAsync(PutBucketLoggingRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketLoggingRequest

Container for the necessary parameters to execute the PutBucketLogging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketLoggingResponse>

The response from the PutBucketLogging service method, as returned by S3.

See Also

REST API Reference for PutBucketLogging Operation

PutBucketMetricsConfigurationAsync(PutBucketMetricsConfigurationRequest, CancellationToken)

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 and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to

PutBucketMetricsConfiguration

:

• DeleteBucketMetricsConfiguration

• PutBucketMetricsConfiguration

• ListBucketMetricsConfigurations

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

public virtual Task<PutBucketMetricsConfigurationResponse> PutBucketMetricsConfigurationAsync(PutBucketMetricsConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketMetricsConfigurationRequest

Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketMetricsConfigurationResponse>

The response from the PutBucketMetricsConfiguration service method, as returned by S3.

See Also

REST API Reference for PutBucketMetricsConfiguration Operation

PutBucketNotificationAsync(PutBucketNotificationRequest, CancellationToken)

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

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

.

<NotificationConfiguration>

</NotificationConfiguration>

This operation 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 AWS 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.

You can disable notifications by adding the empty NotificationConfiguration element.

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.

note

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 operation 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 operation is related to

PutBucketNotificationConfiguration

:

• GetBucketNotificationConfiguration

public virtual Task<PutBucketNotificationResponse> PutBucketNotificationAsync(PutBucketNotificationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketNotificationRequest

Container for the necessary parameters to execute the PutBucketNotification service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketNotificationResponse>

The response from the PutBucketNotification service method, as returned by S3.

See Also

REST API Reference for PutBucketNotification Operation

PutBucketOwnershipControlsAsync(PutBucketOwnershipControlsRequest, CancellationToken)

Creates or modifies

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.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to

GetBucketOwnershipControls

:

• GetBucketOwnershipControls

• DeleteBucketOwnershipControls

public virtual Task<PutBucketOwnershipControlsResponse> PutBucketOwnershipControlsAsync(PutBucketOwnershipControlsRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketOwnershipControlsRequest

Container for the necessary parameters to execute the PutBucketOwnershipControls service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketOwnershipControlsResponse>

The response from the PutBucketOwnershipControls service method, as returned by S3.

See Also

REST API Reference for PutBucketOwnershipControls Operation

PutBucketPolicyAsync(PutBucketPolicyRequest, CancellationToken)

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS 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 AWS 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.

The following operations are related to

PutBucketPolicy

:

• CreateBucket

• DeleteBucket

public virtual Task<PutBucketPolicyResponse> PutBucketPolicyAsync(PutBucketPolicyRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketPolicyRequest

Container for the necessary parameters to execute the PutBucketPolicy service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketPolicyResponse>

The response from the PutBucketPolicy service method, as returned by S3.

See Also

REST API Reference for PutBucketPolicy Operation

PutBucketPolicyAsync(string, string, string, CancellationToken)

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS 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 AWS 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.

The following operations are related to

PutBucketPolicy

:

• CreateBucket

• DeleteBucket

public virtual Task<PutBucketPolicyResponse> PutBucketPolicyAsync(string bucketName, string policy, string contentMD5, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket.

policy string

The bucket policy as a JSON document.

contentMD5 string

The MD5 hash of the request body.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketPolicyResponse>

The response from the PutBucketPolicy service method, as returned by S3.

See Also

REST API Reference for PutBucketPolicy Operation

PutBucketPolicyAsync(string, string, CancellationToken)

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS 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 AWS 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.

The following operations are related to

PutBucketPolicy

:

• CreateBucket

• DeleteBucket

public virtual Task<PutBucketPolicyResponse> PutBucketPolicyAsync(string bucketName, string policy, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket.

policy string

The bucket policy as a JSON document.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketPolicyResponse>

The response from the PutBucketPolicy service method, as returned by S3.

See Also

REST API Reference for PutBucketPolicy Operation

PutBucketReplicationAsync(PutBucketReplicationRequest, CancellationToken)

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.

note

To perform this operation, the user or role performing the operation must have the iam:PassRole permission.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket 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. All rules must specify the same destination bucket.

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

.

note

The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the

Filter

element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the

DeleteMarkerReplication

element to

Disabled

. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.

For information about enabling versioning on a bucket, see Using Versioning.

By default, a resource owner, in this case the AWS 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 and Managing Access Permissions to Your Amazon S3 Resources.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following:

SourceSelectionCriteria

,

SseKmsEncryptedObjects

,

Status

,

EncryptionConfiguration

, and

ReplicaKmsKeyID

. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.

For information on

PutBucketReplication

errors, see List of replication-related error codes

The following operations are related to

PutBucketReplication

:

• GetBucketReplication

• DeleteBucketReplication

public virtual Task<PutBucketReplicationResponse> PutBucketReplicationAsync(PutBucketReplicationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketReplicationRequest

Container for the necessary parameters to execute the PutBucketReplication service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketReplicationResponse>

The response from the PutBucketReplication service method, as returned by S3.

See Also

REST API Reference for PutBucketReplication Operation

PutBucketRequestPaymentAsync(PutBucketRequestPaymentRequest, CancellationToken)

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.

The following operations are related to

PutBucketRequestPayment

:

• CreateBucket

• GetBucketRequestPayment

public virtual Task<PutBucketRequestPaymentResponse> PutBucketRequestPaymentAsync(PutBucketRequestPaymentRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketRequestPaymentRequest

Container for the necessary parameters to execute the PutBucketRequestPayment service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketRequestPaymentResponse>

The response from the PutBucketRequestPayment service method, as returned by S3.

See Also

REST API Reference for PutBucketRequestPayment Operation

PutBucketRequestPaymentAsync(string, RequestPaymentConfiguration, CancellationToken)

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.

The following operations are related to

PutBucketRequestPayment

:

• CreateBucket

• GetBucketRequestPayment

public virtual Task<PutBucketRequestPaymentResponse> PutBucketRequestPaymentAsync(string bucketName, RequestPaymentConfiguration requestPaymentConfiguration, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name.

requestPaymentConfiguration RequestPaymentConfiguration

Container for Payer.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketRequestPaymentResponse>

The response from the PutBucketRequestPayment service method, as returned by S3.

See Also

REST API Reference for PutBucketRequestPayment Operation

PutBucketTaggingAsync(PutBucketTaggingRequest, CancellationToken)

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS 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.

note

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket 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 and Managing Access Permissions to Your Amazon S3 Resources.

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 and AWS-Generated Cost Allocation Tag Restrictions.

• Error code:

  MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code:

  OperationAbortedError

  • Description: A conflicting conditional operation 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

• DeleteBucketTagging

public virtual Task<PutBucketTaggingResponse> PutBucketTaggingAsync(PutBucketTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketTaggingRequest

Container for the necessary parameters to execute the PutBucketTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketTaggingResponse>

The response from the PutBucketTagging service method, as returned by S3.

See Also

REST API Reference for PutBucketTagging Operation

PutBucketTaggingAsync(string, List<Tag>, CancellationToken)

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS 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.

note

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket 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 and Managing Access Permissions to Your Amazon S3 Resources.

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 and AWS-Generated Cost Allocation Tag Restrictions.

• Error code:

  MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code:

  OperationAbortedError

  • Description: A conflicting conditional operation 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

• DeleteBucketTagging

public virtual Task<PutBucketTaggingResponse> PutBucketTaggingAsync(string bucketName, List<Tag> tagSet, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name.

tagSet List<Tag>

A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketTaggingResponse>

The response from the PutBucketTagging service method, as returned by S3.

See Also

REST API Reference for PutBucketTagging Operation

PutBucketVersioningAsync(PutBucketVersioningRequest, CancellationToken)

public virtual Task<PutBucketVersioningResponse> PutBucketVersioningAsync(PutBucketVersioningRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketVersioningRequest

cancellationToken CancellationToken

Returns

Task<PutBucketVersioningResponse>

PutBucketWebsiteAsync(PutBucketWebsiteRequest, CancellationToken)

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.

This PUT operation 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 in the Amazon Simple Storage Service Developer Guide.

public virtual Task<PutBucketWebsiteResponse> PutBucketWebsiteAsync(PutBucketWebsiteRequest request, CancellationToken cancellationToken = default)

Parameters

request PutBucketWebsiteRequest

Container for the necessary parameters to execute the PutBucketWebsite service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketWebsiteResponse>

The response from the PutBucketWebsite service method, as returned by S3.

See Also

REST API Reference for PutBucketWebsite Operation

PutBucketWebsiteAsync(string, WebsiteConfiguration, CancellationToken)

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.

This PUT operation 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 in the Amazon Simple Storage Service Developer Guide.

public virtual Task<PutBucketWebsiteResponse> PutBucketWebsiteAsync(string bucketName, WebsiteConfiguration websiteConfiguration, CancellationToken cancellationToken = default)

Parameters

bucketName string

The bucket name.

websiteConfiguration WebsiteConfiguration

Container for the request.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutBucketWebsiteResponse>

The response from the PutBucketWebsite service method, as returned by S3.

See Also

REST API Reference for PutBucketWebsite Operation

PutCORSConfigurationAsync(PutCORSConfigurationRequest, CancellationToken)

public virtual Task<PutCORSConfigurationResponse> PutCORSConfigurationAsync(PutCORSConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutCORSConfigurationRequest

cancellationToken CancellationToken

Returns

Task<PutCORSConfigurationResponse>

PutCORSConfigurationAsync(string, CORSConfiguration, CancellationToken)

public virtual Task<PutCORSConfigurationResponse> PutCORSConfigurationAsync(string bucketName, CORSConfiguration configuration, CancellationToken cancellationToken = default)

Parameters

bucketName string

configuration CORSConfiguration

cancellationToken CancellationToken

Returns

Task<PutCORSConfigurationResponse>

PutLifecycleConfigurationAsync(PutLifecycleConfigurationRequest, CancellationToken)

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

note

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.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. 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 and Lifecycle Configuration Elements.

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 AWS 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.

The following are related to

PutBucketLifecycleConfiguration

:

• Examples of Lifecycle Configuration

• GetBucketLifecycleConfiguration

• DeleteBucketLifecycle

public virtual Task<PutLifecycleConfigurationResponse> PutLifecycleConfigurationAsync(PutLifecycleConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutLifecycleConfigurationRequest

Container for the necessary parameters to execute the PutLifecycleConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutLifecycleConfigurationResponse>

The response from the PutLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for PutLifecycleConfiguration Operation

PutLifecycleConfigurationAsync(string, LifecycleConfiguration, CancellationToken)

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

note

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.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. 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 and Lifecycle Configuration Elements.

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 AWS 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.

The following are related to

PutBucketLifecycleConfiguration

:

• Examples of Lifecycle Configuration

• GetBucketLifecycleConfiguration

• DeleteBucketLifecycle

public virtual Task<PutLifecycleConfigurationResponse> PutLifecycleConfigurationAsync(string bucketName, LifecycleConfiguration configuration, CancellationToken cancellationToken = default)

Parameters

bucketName string

The name of the bucket for which to set the configuration.

configuration LifecycleConfiguration

A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutLifecycleConfigurationResponse>

The response from the PutLifecycleConfiguration service method, as returned by S3.

See Also

REST API Reference for PutLifecycleConfiguration Operation

PutObjectAsync(PutObjectRequest, CancellationToken)

public virtual Task<PutObjectResponse> PutObjectAsync(PutObjectRequest request, CancellationToken cancellationToken = default)

Parameters

request PutObjectRequest

cancellationToken CancellationToken

Returns

Task<PutObjectResponse>

PutObjectLegalHoldAsync(PutObjectLegalHoldRequest, CancellationToken)

public virtual Task<PutObjectLegalHoldResponse> PutObjectLegalHoldAsync(PutObjectLegalHoldRequest request, CancellationToken cancellationToken = default)

Parameters

request PutObjectLegalHoldRequest

cancellationToken CancellationToken

Returns

Task<PutObjectLegalHoldResponse>

PutObjectLockConfigurationAsync(PutObjectLockConfigurationRequest, CancellationToken)

public virtual Task<PutObjectLockConfigurationResponse> PutObjectLockConfigurationAsync(PutObjectLockConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request PutObjectLockConfigurationRequest

cancellationToken CancellationToken

Returns

Task<PutObjectLockConfigurationResponse>

PutObjectRetentionAsync(PutObjectRetentionRequest, CancellationToken)

public virtual Task<PutObjectRetentionResponse> PutObjectRetentionAsync(PutObjectRetentionRequest request, CancellationToken cancellationToken = default)

Parameters

request PutObjectRetentionRequest

cancellationToken CancellationToken

Returns

Task<PutObjectRetentionResponse>

PutObjectTaggingAsync(PutObjectTaggingRequest, CancellationToken)

public virtual Task<PutObjectTaggingResponse> PutObjectTaggingAsync(PutObjectTaggingRequest request, CancellationToken cancellationToken = default)

Parameters

request PutObjectTaggingRequest

cancellationToken CancellationToken

Returns

Task<PutObjectTaggingResponse>

PutPublicAccessBlockAsync(PutPublicAccessBlockRequest, CancellationToken)

public virtual Task<PutPublicAccessBlockResponse> PutPublicAccessBlockAsync(PutPublicAccessBlockRequest request, CancellationToken cancellationToken = default)

Parameters

request PutPublicAccessBlockRequest

cancellationToken CancellationToken

Returns

Task<PutPublicAccessBlockResponse>

RestoreObjectAsync(RestoreObjectRequest, CancellationToken)

public virtual Task<RestoreObjectResponse> RestoreObjectAsync(RestoreObjectRequest request, CancellationToken cancellationToken = default)

Parameters

request RestoreObjectRequest

cancellationToken CancellationToken

Returns

Task<RestoreObjectResponse>

RestoreObjectAsync(string, string, int, CancellationToken)

public virtual Task<RestoreObjectResponse> RestoreObjectAsync(string bucketName, string key, int days, CancellationToken cancellationToken = default)

Parameters

bucketName string

key string

days int

cancellationToken CancellationToken

Returns

Task<RestoreObjectResponse>

RestoreObjectAsync(string, string, string, int, CancellationToken)

public virtual Task<RestoreObjectResponse> RestoreObjectAsync(string bucketName, string key, string versionId, int days, CancellationToken cancellationToken = default)

Parameters

bucketName string

key string

versionId string

days int

cancellationToken CancellationToken

Returns

Task<RestoreObjectResponse>

RestoreObjectAsync(string, string, string, CancellationToken)

public virtual Task<RestoreObjectResponse> RestoreObjectAsync(string bucketName, string key, string versionId, CancellationToken cancellationToken = default)

Parameters

bucketName string

key string

versionId string

cancellationToken CancellationToken

Returns

Task<RestoreObjectResponse>

RestoreObjectAsync(string, string, CancellationToken)

public virtual Task<RestoreObjectResponse> RestoreObjectAsync(string bucketName, string key, CancellationToken cancellationToken = default)

Parameters

bucketName string

key string

cancellationToken CancellationToken

Returns

Task<RestoreObjectResponse>

SelectObjectContentAsync(SelectObjectContentRequest, CancellationToken)

public virtual Task<SelectObjectContentResponse> SelectObjectContentAsync(SelectObjectContentRequest request, CancellationToken cancellationToken = default)

Parameters

request SelectObjectContentRequest

cancellationToken CancellationToken

Returns

Task<SelectObjectContentResponse>

UploadPartAsync(UploadPartRequest, CancellationToken)

public virtual Task<UploadPartResponse> UploadPartAsync(UploadPartRequest request, CancellationToken cancellationToken = default)

Parameters

request UploadPartRequest

cancellationToken CancellationToken

Returns

Task<UploadPartResponse>