{ "opencollection": "1.0.0", "info": { "name": "Amazon Simple Storage Service API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Amazon Simple Storage Service", "type": "folder" }, "items": [ { "info": { "name": "Amazon S3 - ListParts", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket/:Key#uploadId", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-MD5", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The name of the bucket to which the parts are being uploaded.

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

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

" }, { "name": "Key", "value": "", "type": "path", "description": "Object key for which the multipart upload was initiated." }, { "name": "max-parts", "value": "", "type": "query", "description": "Sets the maximum number of parts to return." }, { "name": "part-number-marker", "value": "", "type": "query", "description": "Specifies the part after which listing should begin. Only parts with higher part numbers will be listed." }, { "name": "uploadId", "value": "", "type": "query", "description": "Upload ID identifying the multipart upload whose parts are being listed." }, { "name": "MaxParts", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "PartNumberMarker", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": "

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-partsName of the bucket to which the multipart upload was initiated.

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

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

" }, { "name": "Key", "value": "", "type": "path", "description": "Object key for which the multipart upload was initiated." }, { "name": "uploadId", "value": "", "type": "query", "description": "ID for the initiated multipart upload." } ] }, "docs": "

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 action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Co" }, { "info": { "name": "Amazon S3 - AbortMultipartUpload", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket/:Key#uploadId", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The bucket name to which the upload was taking place.

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

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

" }, { "name": "Key", "value": "", "type": "path", "description": "Key of the object for which the multipart upload was initiated." }, { "name": "uploadId", "value": "", "type": "query", "description": "Upload ID that identifies the multipart upload." } ] }, "docs": "

This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been r" }, { "info": { "name": "Amazon S3 - CopyObject", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket/:Key#x-amz-copy-source", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-acl", "value": "" }, { "name": "Cache-Control", "value": "" }, { "name": "x-amz-checksum-algorithm", "value": "" }, { "name": "Content-Disposition", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Language", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "x-amz-copy-source", "value": "" }, { "name": "x-amz-copy-source-if-match", "value": "" }, { "name": "x-amz-copy-source-if-modified-since", "value": "" }, { "name": "x-amz-copy-source-if-none-match", "value": "" }, { "name": "x-amz-copy-source-if-unmodified-since", "value": "" }, { "name": "Expires", "value": "" }, { "name": "x-amz-grant-full-control", "value": "" }, { "name": "x-amz-grant-read", "value": "" }, { "name": "x-amz-grant-read-acp", "value": "" }, { "name": "x-amz-grant-write-acp", "value": "" }, { "name": "x-amz-metadata-directive", "value": "" }, { "name": "x-amz-tagging-directive", "value": "" }, { "name": "x-amz-server-side-encryption", "value": "" }, { "name": "x-amz-storage-class", "value": "" }, { "name": "x-amz-website-redirect-location", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-MD5", "value": "" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "" }, { "name": "x-amz-server-side-encryption-context", "value": "" }, { "name": "x-amz-server-side-encryption-bucket-key-enabled", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key-MD5", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-tagging", "value": "" }, { "name": "x-amz-object-lock-mode", "value": "" }, { "name": "x-amz-object-lock-retain-until-date", "value": "" }, { "name": "x-amz-object-lock-legal-hold", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" }, { "name": "x-amz-source-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The name of the destination bucket.

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

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

" }, { "name": "Key", "value": "", "type": "path", "description": "The key of the destination object." } ] }, "docs": "

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

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the RE" }, { "info": { "name": "Amazon S3 - ListObjects", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The name of the bucket containing the objects.

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

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

" }, { "name": "delimiter", "value": "", "type": "query", "description": "A delimiter is a character you use to group keys." }, { "name": "encoding-type", "value": "", "type": "query" }, { "name": "marker", "value": "", "type": "query", "description": "Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket." }, { "name": "max-keys", "value": "", "type": "query", "description": "Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. " }, { "name": "prefix", "value": "", "type": "query", "description": "Limits the response to keys that begin with the specified prefix." }, { "name": "MaxKeys", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "Marker", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, Li" }, { "info": { "name": "Amazon S3 - CreateBucket", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-acl", "value": "" }, { "name": "x-amz-grant-full-control", "value": "" }, { "name": "x-amz-grant-read", "value": "" }, { "name": "x-amz-grant-read-acp", "value": "" }, { "name": "x-amz-grant-write", "value": "" }, { "name": "x-amz-grant-write-acp", "value": "" }, { "name": "x-amz-bucket-object-lock-enabled", "value": "" }, { "name": "x-amz-object-ownership", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket to create." } ] }, "docs": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.

If you" }, { "info": { "name": "Amazon S3 - DeleteBucket", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "Specifies the bucket being deleted." } ] }, "docs": "

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Related Resources

" }, { "info": { "name": "Amazon S3 - HeadBucket", "type": "http" }, "http": { "method": "HEAD", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The bucket name.

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

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

" } ] }, "docs": "

This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 404 Not Found or 403 Forbidden code. A message body is not included, so you cannot determine the exception beyond these error codes.

To use this" }, { "info": { "name": "Amazon S3 - CreateMultipartUpload", "type": "http" }, "http": { "method": "POST", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket/:Key#uploads", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-acl", "value": "" }, { "name": "Cache-Control", "value": "" }, { "name": "Content-Disposition", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Language", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Expires", "value": "" }, { "name": "x-amz-grant-full-control", "value": "" }, { "name": "x-amz-grant-read", "value": "" }, { "name": "x-amz-grant-read-acp", "value": "" }, { "name": "x-amz-grant-write-acp", "value": "" }, { "name": "x-amz-server-side-encryption", "value": "" }, { "name": "x-amz-storage-class", "value": "" }, { "name": "x-amz-website-redirect-location", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-MD5", "value": "" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "" }, { "name": "x-amz-server-side-encryption-context", "value": "" }, { "name": "x-amz-server-side-encryption-bucket-key-enabled", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-tagging", "value": "" }, { "name": "x-amz-object-lock-mode", "value": "" }, { "name": "x-amz-object-lock-retain-until-date", "value": "" }, { "name": "x-amz-object-lock-legal-hold", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" }, { "name": "x-amz-checksum-algorithm", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "

The name of the bucket to which to initiate the upload

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

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

" }, { "name": "Key", "value": "", "type": "path", "description": "Object key for which the multipart upload is to be initiated." }, { "name": "uploads", "value": "", "type": "query" } ] }, "docs": "

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). 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 " }, { "info": { "name": "Amazon S3 - GetBucketAnalyticsConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#analytics&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket from which an analytics configuration is retrieved." }, { "name": "id", "value": "", "type": "query", "description": "The ID that identifies the analytics configuration." }, { "name": "analytics", "value": "", "type": "query" } ] }, "docs": "

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destin" }, { "info": { "name": "Amazon S3 - DeleteBucketAnalyticsConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#analytics&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket from which an analytics configuration is deleted." }, { "name": "id", "value": "", "type": "query", "description": "The ID that identifies the analytics configuration." }, { "name": "analytics", "value": "", "type": "query" } ] }, "docs": "

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 Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBu" }, { "info": { "name": "Amazon S3 - PutBucketCors", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#cors", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "x-amz-sdk-checksum-algorithm", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "Specifies the bucket impacted by the corsconfiguration." }, { "name": "cors", "value": "", "type": "query" } ] }, "docs": "

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to acce" }, { "info": { "name": "Amazon S3 - DeleteBucketCors", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#cors", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "Specifies the bucket whose cors configuration is being deleted." }, { "name": "cors", "value": "", "type": "query" } ] }, "docs": "

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError.

For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

To use this operation, you must have permission to perform the Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide." }, { "name": "encryption", "value": "", "type": "query" } ] }, "docs": "

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for en" }, { "info": { "name": "Amazon S3 - DeleteBucketEncryption", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#encryption", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket containing the server-side encryption configuration to delete." }, { "name": "encryption", "value": "", "type": "query" } ] }, "docs": "

This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner" }, { "info": { "name": "Amazon S3 - GetBucketIntelligentTieringConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#intelligent-tiering&id", "headers": [ { "name": "x-amz-security-token", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the S3 Intelligent-Tiering configuration." }, { "name": "intelligent-tiering", "value": "", "type": "query" } ] }, "docs": "

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to " }, { "info": { "name": "Amazon S3 - PutBucketIntelligentTieringConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#intelligent-tiering&id", "headers": [ { "name": "x-amz-security-token", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the S3 Intelligent-Tiering configuration." }, { "name": "intelligent-tiering", "value": "", "type": "query" } ] }, "docs": "

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage co" }, { "info": { "name": "Amazon S3 - DeleteBucketIntelligentTieringConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#intelligent-tiering&id", "headers": [ { "name": "x-amz-security-token", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the S3 Intelligent-Tiering configuration." }, { "name": "intelligent-tiering", "value": "", "type": "query" } ] }, "docs": "

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose " }, { "info": { "name": "Amazon S3 - GetBucketInventoryConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#inventory&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket containing the inventory configuration to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the inventory configuration." }, { "name": "inventory", "value": "", "type": "query" } ] }, "docs": "

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 " }, { "info": { "name": "Amazon S3 - PutBucketInventoryConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#inventory&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket where the inventory configuration will be stored." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the inventory configuration." }, { "name": "inventory", "value": "", "type": "query" } ] }, "docs": "

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination<" }, { "info": { "name": "Amazon S3 - DeleteBucketInventoryConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#inventory&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket containing the inventory configuration to delete." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the inventory configuration." }, { "name": "inventory", "value": "", "type": "query" } ] }, "docs": "

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 " }, { "info": { "name": "Amazon S3 - GetBucketLifecycleConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#lifecycle", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket for which to get the lifecycle information." }, { "name": "lifecycle", "value": "", "type": "query" } ] }, "docs": "

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Bucket lifecycle " }, { "info": { "name": "Amazon S3 - DeleteBucketLifecycle", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#lifecycle", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket name of the lifecycle to delete." }, { "name": "lifecycle", "value": "", "type": "query" } ] }, "docs": "

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 permis" }, { "info": { "name": "Amazon S3 - GetBucketMetricsConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#metrics&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket containing the metrics configuration to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the metrics configuration." }, { "name": "metrics", "value": "", "type": "query" } ] }, "docs": "

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 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 perm" }, { "info": { "name": "Amazon S3 - DeleteBucketMetricsConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#metrics&id", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket containing the metrics configuration to delete." }, { "name": "id", "value": "", "type": "query", "description": "The ID used to identify the metrics configuration." }, { "name": "metrics", "value": "", "type": "query" } ] }, "docs": "

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 OwnershipControls you want to retrieve. " }, { "name": "ownershipControls", "value": "", "type": "query" } ] }, "docs": "

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 OwnershipControls you want to set." }, { "name": "ownershipControls", "value": "", "type": "query" } ] }, "docs": "

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see OwnershipControls you want to delete. " }, { "name": "ownershipControls", "value": "", "type": "query" } ] }, "docs": "

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 Objec" }, { "info": { "name": "Amazon S3 - GetBucketPolicy", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#policy", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket name for which to get the bucket policy." }, { "name": "policy", "value": "", "type": "query" } ] }, "docs": "

Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you'r" }, { "info": { "name": "Amazon S3 - PutBucketPolicy", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#policy", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "x-amz-sdk-checksum-algorithm", "value": "" }, { "name": "x-amz-confirm-remove-self-bucket-access", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket." }, { "name": "policy", "value": "", "type": "query" } ] }, "docs": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permi" }, { "info": { "name": "Amazon S3 - DeleteBucketPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#policy", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket name." }, { "name": "policy", "value": "", "type": "query" } ] }, "docs": "

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Acces" }, { "info": { "name": "Amazon S3 - GetBucketReplication", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#replication", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket name for which to get the replication information." }, { "name": "replication", "value": "", "type": "query" } ] }, "docs": "

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

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

This action requires permissions for the Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your beha" }, { "info": { "name": "Amazon S3 - DeleteBucketReplication", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#replication", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": " The bucket name. " }, { "name": "replication", "value": "", "type": "query" } ] }, "docs": "

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" }, { "info": { "name": "Amazon S3 - GetBucketTagging", "type": "http" }, "http": { "method": "GET", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#tagging", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket for which to get the tagging information." }, { "name": "tagging", "value": "", "type": "query" } ] }, "docs": "

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSet

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

The followin" }, { "info": { "name": "Amazon S3 - PutBucketTagging", "type": "http" }, "http": { "method": "PUT", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#tagging", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "x-amz-sdk-checksum-algorithm", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket name." }, { "name": "tagging", "value": "", "type": "query" } ] }, "docs": "

Sets the tags for a bucket.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of tha" }, { "info": { "name": "Amazon S3 - DeleteBucketTagging", "type": "http" }, "http": { "method": "DELETE", "url": "http://s3{dash-or-dot}{region}.amazonaws.com/:Bucket#tagging", "headers": [ { "name": "x-amz-security-token", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The bucket that has the tag set to be removed." }, { "name": "tagging", "value": "", "type": "query" } ] }, "docs": "

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: