Amazon Simple Storage Service

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes , you must have READ access to the object.

GetObjectAttributes combines the functionality of GetObjectAcl , GetObjectLegalHold , GetObjectLockConfiguration , GetObjectRetention , GetObjectTagging , HeadObject , and ListParts . All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes .

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

• x-amz-server-side-encryption-customer-algorithm

• x-amz-server-side-encryption-customer-key

• x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide .

Consider the following when using request headers:

• If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

  • If-Match condition evaluates to true .

  • If-Unmodified-Since condition evaluates to false .

• If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified :

  • If-None-Match condition evaluates to false .

  • If-Modified-Since condition evaluates to true .

For more information about conditional requests, see RFC 7232 .

Permissions

The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide . If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

• If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error.

• If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

The following actions are related to GetObjectAttributes :

• GetObject

• GetObjectAcl

• GetObjectLegalHold

• GetObjectLockConfiguration

• GetObjectRetention

• GetObjectTagging

• HeadObject

• ListParts

See also: AWS API Documentation

Request Syntax

client.get_object_attributes(
    Bucket='string',
    Key='string',
    VersionId='string',
    MaxParts=123,
    PartNumberMarker=123,
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    ObjectAttributes=[
        'ETag'|'Checksum'|'ObjectParts'|'StorageClass'|'ObjectSize',
    ]
)

type Bucket

string

param Bucket

[REQUIRED]

The name of the bucket that contains the object.

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

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

type Key

string

param Key

[REQUIRED]

The object key.

type VersionId

string

param VersionId

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

type MaxParts

integer

param MaxParts

Sets the maximum number of parts to return.

type PartNumberMarker

integer

param PartNumberMarker

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

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ObjectAttributes

list

param ObjectAttributes

[REQUIRED]

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

• (string) --

rtype

dict

returns

Response Syntax

{
    'DeleteMarker': True|False,
    'LastModified': datetime(2015, 1, 1),
    'VersionId': 'string',
    'RequestCharged': 'requester',
    'ETag': 'string',
    'Checksum': {
        'ChecksumCRC32': 'string',
        'ChecksumCRC32C': 'string',
        'ChecksumSHA1': 'string',
        'ChecksumSHA256': 'string'
    },
    'ObjectParts': {
        'TotalPartsCount': 123,
        'PartNumberMarker': 123,
        'NextPartNumberMarker': 123,
        'MaxParts': 123,
        'IsTruncated': True|False,
        'Parts': [
            {
                'PartNumber': 123,
                'Size': 123,
                'ChecksumCRC32': 'string',
                'ChecksumCRC32C': 'string',
                'ChecksumSHA1': 'string',
                'ChecksumSHA256': 'string'
            },
        ]
    },
    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    'ObjectSize': 123
}

Response Structure

• (dict) --

  • DeleteMarker (boolean) --

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

  • LastModified (datetime) --

    The creation date of the object.

  • VersionId (string) --

    The version ID of the object.

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • ETag (string) --

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

  • Checksum (dict) --

    The checksum or digest of the object.

    • ChecksumCRC32 (string) --

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

    • ChecksumCRC32C (string) --

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

    • ChecksumSHA1 (string) --

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

    • ChecksumSHA256 (string) --

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

  • ObjectParts (dict) --

    A collection of parts associated with a multipart upload.

    • TotalPartsCount (integer) --

      The total number of parts.

    • PartNumberMarker (integer) --

      The marker for the current part.

    • NextPartNumberMarker (integer) --

      When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.

    • MaxParts (integer) --

      The maximum number of parts allowed in the response.

    • IsTruncated (boolean) --

      Indicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

    • Parts (list) --

      A container for elements related to a particular part. A response can contain zero or more Parts elements.

      • (dict) --

        A container for elements related to an individual part.

        • PartNumber (integer) --

          The part number identifying the part. This value is a positive integer between 1 and 10,000.

        • Size (integer) --

          The size of the uploaded part in bytes.

        • ChecksumCRC32 (string) --

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

        • ChecksumCRC32C (string) --

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

        • ChecksumSHA1 (string) --

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

        • ChecksumSHA256 (string) --

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

  • StorageClass (string) --

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

    For more information, see Storage Classes .

  • ObjectSize (integer) --

    The size of the object in bytes.

{'ChecksumCRC32': 'string',
 'ChecksumCRC32C': 'string',
 'ChecksumSHA1': 'string',
 'ChecksumSHA256': 'string',
 'MultipartUpload': {'Parts': {'ChecksumCRC32': 'string',
                               'ChecksumCRC32C': 'string',
                               'ChecksumSHA1': 'string',
                               'ChecksumSHA256': 'string'}},
 'SSECustomerAlgorithm': 'string',
 'SSECustomerKey': 'blob',
 'SSECustomerKeyMD5': 'string'}

{'ChecksumCRC32': 'string',
 'ChecksumCRC32C': 'string',
 'ChecksumSHA1': 'string',
 'ChecksumSHA256': 'string'}

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 Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices .

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

See also: AWS API Documentation

Request Syntax

client.complete_multipart_upload(
    Bucket='string',
    Key='string',
    MultipartUpload={
        'Parts': [
            {
                'ETag': 'string',
                'ChecksumCRC32': 'string',
                'ChecksumCRC32C': 'string',
                'ChecksumSHA1': 'string',
                'ChecksumSHA256': 'string',
                'PartNumber': 123
            },
        ]
    },
    UploadId='string',
    ChecksumCRC32='string',
    ChecksumCRC32C='string',
    ChecksumSHA1='string',
    ChecksumSHA256='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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

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

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

type Key

string

param Key

[REQUIRED]

Object key for which the multipart upload was initiated.

type MultipartUpload

dict

param MultipartUpload

The container for the multipart upload request information.

• Parts (list) --

  Array of CompletedPart data types.

  If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.

  • (dict) --

    Details of the parts that were uploaded.

    • ETag (string) --

      Entity tag returned when the part was uploaded.

    • ChecksumCRC32 (string) --

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

    • ChecksumCRC32C (string) --

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

    • ChecksumSHA1 (string) --

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

    • ChecksumSHA256 (string) --

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

    • PartNumber (integer) --

      Part number that identifies the part. This is a positive integer between 1 and 10,000.

type UploadId

string

param UploadId

[REQUIRED]

ID for the initiated multipart upload.

type ChecksumCRC32

string

param ChecksumCRC32

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

type ChecksumCRC32C

string

param ChecksumCRC32C

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

type ChecksumSHA1

string

param ChecksumSHA1

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

type ChecksumSHA256

string

param ChecksumSHA256

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

rtype

dict

returns

Response Syntax

{
    'Location': 'string',
    'Bucket': 'string',
    'Key': 'string',
    'Expiration': 'string',
    'ETag': 'string',
    'ChecksumCRC32': 'string',
    'ChecksumCRC32C': 'string',
    'ChecksumSHA1': 'string',
    'ChecksumSHA256': 'string',
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'VersionId': 'string',
    'SSEKMSKeyId': 'string',
    'BucketKeyEnabled': True|False,
    'RequestCharged': 'requester'
}

Response Structure

• (dict) --

  • Location (string) --

    The URI that identifies the newly created object.

  • Bucket (string) --

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

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

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

  • Key (string) --

    The object key of the newly created object.

  • Expiration (string) --

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

  • ETag (string) --

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

  • ChecksumCRC32 (string) --

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

  • ChecksumCRC32C (string) --

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

  • ChecksumSHA1 (string) --

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

  • ChecksumSHA256 (string) --

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

  • ServerSideEncryption (string) --

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

  • VersionId (string) --

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

  • SSEKMSKeyId (string) --

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

  • BucketKeyEnabled (boolean) --

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

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

{'CopyObjectResult': {'ChecksumCRC32': 'string',
                      'ChecksumCRC32C': 'string',
                      'ChecksumSHA1': 'string',
                      'ChecksumSHA256': 'string'}}

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

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 action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

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 .

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

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption .

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide .

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API .

If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide .

When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header.

Storage Class Options

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide .

Versioning

By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject .

The following operations are related to CopyObject :

• PutObject

• GetObject

For more information, see Copying Objects .

See also: AWS API Documentation

Request Syntax

client.copy_object(
    ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control',
    Bucket='string',
    CacheControl='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ContentDisposition='string',
    ContentEncoding='string',
    ContentLanguage='string',
    ContentType='string',
    CopySource='string',
    CopySourceIfMatch='string',
    CopySourceIfModifiedSince=datetime(2015, 1, 1),
    CopySourceIfNoneMatch='string',
    CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
    Expires=datetime(2015, 1, 1),
    GrantFullControl='string',
    GrantRead='string',
    GrantReadACP='string',
    GrantWriteACP='string',
    Key='string',
    Metadata={
        'string': 'string'
    },
    MetadataDirective='COPY'|'REPLACE',
    TaggingDirective='COPY'|'REPLACE',
    ServerSideEncryption='AES256'|'aws:kms',
    StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    WebsiteRedirectLocation='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string',
    SSEKMSKeyId='string',
    SSEKMSEncryptionContext='string',
    BucketKeyEnabled=True|False,
    CopySourceSSECustomerAlgorithm='string',
    CopySourceSSECustomerKey=b'bytes',
    CopySourceSSECustomerKeyMD5='string',
    RequestPayer='requester',
    Tagging='string',
    ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
    ObjectLockRetainUntilDate=datetime(2015, 1, 1),
    ObjectLockLegalHoldStatus='ON'|'OFF',
    ExpectedBucketOwner='string',
    ExpectedSourceBucketOwner='string'
)

type ACL

string

param ACL

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

type Bucket

string

param Bucket

[REQUIRED]

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 .

type CacheControl

string

param CacheControl

Specifies caching behavior along the request/reply chain.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

type ContentDisposition

string

param ContentDisposition

Specifies presentational information for the object.

type ContentEncoding

string

param ContentEncoding

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

type ContentLanguage

string

param ContentLanguage

The language the content is in.

type ContentType

string

param ContentType

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

type CopySource

string

param CopySource

[REQUIRED]

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

• For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket , use awsexamplebucket/reports/january.pdf . The value must be URL-encoded.

• For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf . The value must be URL encoded.

Note

Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf . The value must be URL-encoded.

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

type CopySourceIfMatch

string

param CopySourceIfMatch

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

type CopySourceIfModifiedSince

datetime

param CopySourceIfModifiedSince

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

type CopySourceIfNoneMatch

string

param CopySourceIfNoneMatch

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

type CopySourceIfUnmodifiedSince

datetime

param CopySourceIfUnmodifiedSince

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

type Expires

datetime

param Expires

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

type GrantFullControl

string

param GrantFullControl

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

This action is not supported by Amazon S3 on Outposts.

type GrantRead

string

param GrantRead

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

type GrantReadACP

string

param GrantReadACP

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

type GrantWriteACP

string

param GrantWriteACP

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

type Key

string

param Key

[REQUIRED]

The key of the destination object.

type Metadata

dict

param Metadata

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

• (string) --

  • (string) --

type MetadataDirective

string

param MetadataDirective

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

type TaggingDirective

string

param TaggingDirective

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

type ServerSideEncryption

string

param ServerSideEncryption

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

type StorageClass

string

param StorageClass

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

type WebsiteRedirectLocation

string

param WebsiteRedirectLocation

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

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

type SSEKMSKeyId

string

param SSEKMSKeyId

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

type SSEKMSEncryptionContext

string

param SSEKMSEncryptionContext

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

type BucketKeyEnabled

boolean

param BucketKeyEnabled

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

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

type CopySourceSSECustomerAlgorithm

string

param CopySourceSSECustomerAlgorithm

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

type CopySourceSSECustomerKey

bytes

param CopySourceSSECustomerKey

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

type CopySourceSSECustomerKeyMD5

string

param CopySourceSSECustomerKeyMD5

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type Tagging

string

param Tagging

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

type ObjectLockMode

string

param ObjectLockMode

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

type ObjectLockRetainUntilDate

datetime

param ObjectLockRetainUntilDate

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

type ObjectLockLegalHoldStatus

string

param ObjectLockLegalHoldStatus

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ExpectedSourceBucketOwner

string

param ExpectedSourceBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'CopyObjectResult': {
        'ETag': 'string',
        'LastModified': datetime(2015, 1, 1),
        'ChecksumCRC32': 'string',
        'ChecksumCRC32C': 'string',
        'ChecksumSHA1': 'string',
        'ChecksumSHA256': 'string'
    },
    'Expiration': 'string',
    'CopySourceVersionId': 'string',
    'VersionId': 'string',
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'SSECustomerAlgorithm': 'string',
    'SSECustomerKeyMD5': 'string',
    'SSEKMSKeyId': 'string',
    'SSEKMSEncryptionContext': 'string',
    'BucketKeyEnabled': True|False,
    'RequestCharged': 'requester'
}

Response Structure

• (dict) --

  • CopyObjectResult (dict) --

    Container for all response elements.

    • ETag (string) --

      Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

    • LastModified (datetime) --

      Creation date of the object.

    • ChecksumCRC32 (string) --

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

    • ChecksumCRC32C (string) --

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

    • ChecksumSHA1 (string) --

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

    • ChecksumSHA256 (string) --

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

  • Expiration (string) --

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

  • CopySourceVersionId (string) --

    Version of the copied object in the destination bucket.

  • VersionId (string) --

    Version ID of the newly created copy.

  • ServerSideEncryption (string) --

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

  • SSECustomerAlgorithm (string) --

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

  • SSECustomerKeyMD5 (string) --

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

  • SSEKMSKeyId (string) --

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

  • SSEKMSEncryptionContext (string) --

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

  • BucketKeyEnabled (boolean) --

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

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

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 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 action 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 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 (Amazon Web Services Signature Version 4) .

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart 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 Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide .

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption .

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

• Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.

  • x-amz-server-side-encryption

  • x-amz-server-side-encryption-aws-kms-key-id

  • x-amz-server-side-encryption-context

For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys .

• Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

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

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs . 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 Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview . In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

  • x-amz-grant-read

  • x-amz-grant-write

  • x-amz-grant-read-acp

  • x-amz-grant-write-acp

  • x-amz-grant-full-control

You specify each grantee as a type=value pair, where the type is one of the following:

• id – if the value specified is the canonical user ID of an Amazon Web Services account

• uri – if you are granting permissions to a predefined group

• emailAddress – if the value specified is the email address of an Amazon Web Services account

Note

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

• US East (N. Virginia)

• US West (N. California)

• US West (Oregon)

• Asia Pacific (Singapore)

• Asia Pacific (Sydney)

• Asia Pacific (Tokyo)

• Europe (Ireland)

• South America (São Paulo)

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

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

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

The following operations are related to CreateMultipartUpload :

• UploadPart

• CompleteMultipartUpload

• AbortMultipartUpload

• ListParts

• ListMultipartUploads

See also: AWS API Documentation

Request Syntax

client.create_multipart_upload(
    ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control',
    Bucket='string',
    CacheControl='string',
    ContentDisposition='string',
    ContentEncoding='string',
    ContentLanguage='string',
    ContentType='string',
    Expires=datetime(2015, 1, 1),
    GrantFullControl='string',
    GrantRead='string',
    GrantReadACP='string',
    GrantWriteACP='string',
    Key='string',
    Metadata={
        'string': 'string'
    },
    ServerSideEncryption='AES256'|'aws:kms',
    StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    WebsiteRedirectLocation='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string',
    SSEKMSKeyId='string',
    SSEKMSEncryptionContext='string',
    BucketKeyEnabled=True|False,
    RequestPayer='requester',
    Tagging='string',
    ObjectLockMode='GOVERNANCE'|'COMPLIANCE',
    ObjectLockRetainUntilDate=datetime(2015, 1, 1),
    ObjectLockLegalHoldStatus='ON'|'OFF',
    ExpectedBucketOwner='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'
)

type ACL

string

param ACL

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

type Bucket

string

param Bucket

[REQUIRED]

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 .

type CacheControl

string

param CacheControl

Specifies caching behavior along the request/reply chain.

type ContentDisposition

string

param ContentDisposition

Specifies presentational information for the object.

type ContentEncoding

string

param ContentEncoding

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

type ContentLanguage

string

param ContentLanguage

The language the content is in.

type ContentType

string

param ContentType

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

type Expires

datetime

param Expires

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

type GrantFullControl

string

param GrantFullControl

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

This action is not supported by Amazon S3 on Outposts.

type GrantRead

string

param GrantRead

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

type GrantReadACP

string

param GrantReadACP

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

type GrantWriteACP

string

param GrantWriteACP

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

type Key

string

param Key

[REQUIRED]

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

type Metadata

dict

param Metadata

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

• (string) --

  • (string) --

type ServerSideEncryption

string

param ServerSideEncryption

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

type StorageClass

string

param StorageClass

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

type WebsiteRedirectLocation

string

param WebsiteRedirectLocation

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

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

type SSEKMSKeyId

string

param SSEKMSKeyId

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

type SSEKMSEncryptionContext

string

param SSEKMSEncryptionContext

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

type BucketKeyEnabled

boolean

param BucketKeyEnabled

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

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type Tagging

string

param Tagging

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

type ObjectLockMode

string

param ObjectLockMode

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

type ObjectLockRetainUntilDate

datetime

param ObjectLockRetainUntilDate

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

type ObjectLockLegalHoldStatus

string

param ObjectLockLegalHoldStatus

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

rtype

dict

returns

Response Syntax

{
    'AbortDate': datetime(2015, 1, 1),
    'AbortRuleId': 'string',
    'Bucket': 'string',
    'Key': 'string',
    'UploadId': 'string',
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'SSECustomerAlgorithm': 'string',
    'SSECustomerKeyMD5': 'string',
    'SSEKMSKeyId': 'string',
    'SSEKMSEncryptionContext': 'string',
    'BucketKeyEnabled': True|False,
    'RequestCharged': 'requester',
    'ChecksumAlgorithm': 'CRC32'|'CRC32C'|'SHA1'|'SHA256'
}

Response Structure

• (dict) --

  • AbortDate (datetime) --

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

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

  • AbortRuleId (string) --

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

  • Bucket (string) --

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

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

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

  • Key (string) --

    Object key for which the multipart upload was initiated.

  • UploadId (string) --

    ID for the initiated multipart upload.

  • ServerSideEncryption (string) --

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

  • SSECustomerAlgorithm (string) --

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

  • SSECustomerKeyMD5 (string) --

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

  • SSEKMSKeyId (string) --

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

  • SSEKMSEncryptionContext (string) --

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

  • BucketKeyEnabled (boolean) --

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

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • ChecksumAlgorithm (string) --

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

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete .

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

See also: AWS API Documentation

Request Syntax

client.delete_objects(
    Bucket='string',
    Delete={
        'Objects': [
            {
                'Key': 'string',
                'VersionId': 'string'
            },
        ],
        'Quiet': True|False
    },
    MFA='string',
    RequestPayer='requester',
    BypassGovernanceRetention=True|False,
    ExpectedBucketOwner='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'
)

type Bucket

string

param Bucket

[REQUIRED]

The bucket name containing the objects to delete.

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

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

type Delete

dict

param Delete

[REQUIRED]

Container for the request.

• Objects (list) -- [REQUIRED]

  The objects to delete.

  • (dict) --

    Object Identifier is unique value to identify objects.

    • Key (string) -- [REQUIRED]

      Key name of the object.

      Warning

      Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints .

    • VersionId (string) --

      VersionId for the specific version of the object to delete.

• Quiet (boolean) --

  Element to enable quiet mode for the request. When you add this element, you must set its value to true.

type MFA

string

param MFA

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type BypassGovernanceRetention

boolean

param BypassGovernanceRetention

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

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

rtype

dict

returns

Response Syntax

{
    'Deleted': [
        {
            'Key': 'string',
            'VersionId': 'string',
            'DeleteMarker': True|False,
            'DeleteMarkerVersionId': 'string'
        },
    ],
    'RequestCharged': 'requester',
    'Errors': [
        {
            'Key': 'string',
            'VersionId': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Deleted (list) --

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

    • (dict) --

      Information about the deleted object.

      • Key (string) --

        The name of the deleted object.

      • VersionId (string) --

        The version ID of the deleted object.

      • DeleteMarker (boolean) --

        Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.

      • DeleteMarkerVersionId (string) --

        The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • Errors (list) --

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

    • (dict) --

      Container for all error elements.

      • Key (string) --

        The error key.

      • VersionId (string) --

        The version ID of the error.

      • Code (string) --

        The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.

        Amazon S3 error codes

        • • Code: AccessDenied

          • Description: Access Denied

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: AccountProblem

          • Description: There is a problem with your Amazon Web Services account that prevents the action from completing successfully. Contact Amazon Web Services Support for further assistance.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: AllAccessDisabled

          • Description: All access to this Amazon S3 resource has been disabled. Contact Amazon Web Services Support for further assistance.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: AmbiguousGrantByEmailAddress

          • Description: The email address you provided is associated with more than one account.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: AuthorizationHeaderMalformed

          • Description: The authorization header you provided is invalid.

          • HTTP Status Code: 400 Bad Request

          • HTTP Status Code: N/A

        • • Code: BadDigest

          • Description: The Content-MD5 you specified did not match what we received.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: BucketAlreadyExists

          • Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.

          • HTTP Status Code: 409 Conflict

          • SOAP Fault Code Prefix: Client

        • • Code: BucketAlreadyOwnedByYou

          • Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).

          • Code: 409 Conflict (in all Regions except the North Virginia Region)

          • SOAP Fault Code Prefix: Client

        • • Code: BucketNotEmpty

          • Description: The bucket you tried to delete is not empty.

          • HTTP Status Code: 409 Conflict

          • SOAP Fault Code Prefix: Client

        • • Code: CredentialsNotSupported

          • Description: This request does not support credentials.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: CrossLocationLoggingProhibited

          • Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: EntityTooSmall

          • Description: Your proposed upload is smaller than the minimum allowed object size.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: EntityTooLarge

          • Description: Your proposed upload exceeds the maximum allowed object size.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: ExpiredToken

          • Description: The provided token has expired.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: IllegalVersioningConfigurationException

          • Description: Indicates that the versioning configuration specified in the request is invalid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: IncompleteBody

          • Description: You did not provide the number of bytes specified by the Content-Length HTTP header

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: IncorrectNumberOfFilesInPostRequest

          • Description: POST requires exactly one file upload per request.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InlineDataTooLarge

          • Description: Inline data exceeds the maximum allowed size.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InternalError

          • Description: We encountered an internal error. Please try again.

          • HTTP Status Code: 500 Internal Server Error

          • SOAP Fault Code Prefix: Server

        • • Code: InvalidAccessKeyId

          • Description: The Amazon Web Services access key ID you provided does not exist in our records.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidAddressingHeader

          • Description: You must specify the Anonymous role.

          • HTTP Status Code: N/A

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidArgument

          • Description: Invalid Argument

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidBucketName

          • Description: The specified bucket is not valid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidBucketState

          • Description: The request is not valid with the current state of the bucket.

          • HTTP Status Code: 409 Conflict

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidDigest

          • Description: The Content-MD5 you specified is not valid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidEncryptionAlgorithmError

          • Description: The encryption request you specified is not valid. The valid value is AES256.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidLocationConstraint

          • Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets .

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidObjectState

          • Description: The action is not valid for the current state of the object.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidPart

          • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidPartOrder

          • Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidPayer

          • Description: All access to this object has been disabled. Please contact Amazon Web Services Support for further assistance.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidPolicyDocument

          • Description: The content of the form does not meet the conditions specified in the policy document.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidRange

          • Description: The requested range cannot be satisfied.

          • HTTP Status Code: 416 Requested Range Not Satisfiable

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidRequest

          • Description: Please use AWS4-HMAC-SHA256 .

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: SOAP requests must be made over an HTTPS connection.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Accelerate is not configured on this bucket.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Accelerate is disabled on this bucket.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact Amazon Web Services Support for more information.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidRequest

          • Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact Amazon Web Services Support for more information.

          • HTTP Status Code: 400 Bad Request

          • Code: N/A

        • • Code: InvalidSecurity

          • Description: The provided security credentials are not valid.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidSOAPRequest

          • Description: The SOAP request body is invalid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidStorageClass

          • Description: The storage class you specified is not valid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidTargetBucketForLogging

          • Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidToken

          • Description: The provided token is malformed or otherwise invalid.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: InvalidURI

          • Description: Couldn't parse the specified URI.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: KeyTooLongError

          • Description: Your key is too long.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MalformedACLError

          • Description: The XML you provided was not well-formed or did not validate against our published schema.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MalformedPOSTRequest

          • Description: The body of your POST request is not well-formed multipart/form-data.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MalformedXML

          • Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema."

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MaxMessageLengthExceeded

          • Description: Your request was too big.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MaxPostPreDataLengthExceededError

          • Description: Your POST request fields preceding the upload file were too large.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MetadataTooLarge

          • Description: Your metadata headers exceed the maximum allowed metadata size.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MethodNotAllowed

          • Description: The specified method is not allowed against this resource.

          • HTTP Status Code: 405 Method Not Allowed

          • SOAP Fault Code Prefix: Client

        • • Code: MissingAttachment

          • Description: A SOAP attachment was expected, but none were found.

          • HTTP Status Code: N/A

          • SOAP Fault Code Prefix: Client

        • • Code: MissingContentLength

          • Description: You must provide the Content-Length HTTP header.

          • HTTP Status Code: 411 Length Required

          • SOAP Fault Code Prefix: Client

        • • Code: MissingRequestBodyError

          • Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty."

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MissingSecurityElement

          • Description: The SOAP 1.1 request is missing a security element.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: MissingSecurityHeader

          • Description: Your request is missing a required header.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: NoLoggingStatusForKey

          • Description: There is no such thing as a logging status subresource for a key.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchBucket

          • Description: The specified bucket does not exist.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchBucketPolicy

          • Description: The specified bucket does not have a bucket policy.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchKey

          • Description: The specified key does not exist.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchLifecycleConfiguration

          • Description: The lifecycle configuration does not exist.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchUpload

          • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NoSuchVersion

          • Description: Indicates that the version ID specified in the request does not match an existing version.

          • HTTP Status Code: 404 Not Found

          • SOAP Fault Code Prefix: Client

        • • Code: NotImplemented

          • Description: A header you provided implies functionality that is not implemented.

          • HTTP Status Code: 501 Not Implemented

          • SOAP Fault Code Prefix: Server

        • • Code: NotSignedUp

          • Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: Amazon S3

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: OperationAborted

          • Description: A conflicting conditional action is currently in progress against this resource. Try again.

          • HTTP Status Code: 409 Conflict

          • SOAP Fault Code Prefix: Client

        • • Code: PermanentRedirect

          • Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.

          • HTTP Status Code: 301 Moved Permanently

          • SOAP Fault Code Prefix: Client

        • • Code: PreconditionFailed

          • Description: At least one of the preconditions you specified did not hold.

          • HTTP Status Code: 412 Precondition Failed

          • SOAP Fault Code Prefix: Client

        • • Code: Redirect

          • Description: Temporary redirect.

          • HTTP Status Code: 307 Moved Temporarily

          • SOAP Fault Code Prefix: Client

        • • Code: RestoreAlreadyInProgress

          • Description: Object restore is already in progress.

          • HTTP Status Code: 409 Conflict

          • SOAP Fault Code Prefix: Client

        • • Code: RequestIsNotMultiPartContent

          • Description: Bucket POST must be of the enclosure-type multipart/form-data.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: RequestTimeout

          • Description: Your socket connection to the server was not read from or written to within the timeout period.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: RequestTimeTooSkewed

          • Description: The difference between the request time and the server's time is too large.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: RequestTorrentOfBucketError

          • Description: Requesting the torrent file of a bucket is not permitted.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: SignatureDoesNotMatch

          • Description: The request signature we calculated does not match the signature you provided. Check your Amazon Web Services secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.

          • HTTP Status Code: 403 Forbidden

          • SOAP Fault Code Prefix: Client

        • • Code: ServiceUnavailable

          • Description: Reduce your request rate.

          • HTTP Status Code: 503 Service Unavailable

          • SOAP Fault Code Prefix: Server

        • • Code: SlowDown

          • Description: Reduce your request rate.

          • HTTP Status Code: 503 Slow Down

          • SOAP Fault Code Prefix: Server

        • • Code: TemporaryRedirect

          • Description: You are being redirected to the bucket while DNS updates.

          • HTTP Status Code: 307 Moved Temporarily

          • SOAP Fault Code Prefix: Client

        • • Code: TokenRefreshRequired

          • Description: The provided token must be refreshed.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: TooManyBuckets

          • Description: You have attempted to create more buckets than allowed.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: UnexpectedContent

          • Description: This request does not support content.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: UnresolvableGrantByEmailAddress

          • Description: The email address you provided does not match any account on record.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

        • • Code: UserKeyMustBeSpecified

          • Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.

          • HTTP Status Code: 400 Bad Request

          • SOAP Fault Code Prefix: Client

      • Message (string) --

        The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

{'InventoryConfiguration': {'OptionalFields': {'ChecksumAlgorithm'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_bucket_inventory_configuration(
    Bucket='string',
    Id='string',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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

type Id

string

param Id

[REQUIRED]

The ID used to identify the inventory configuration.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'InventoryConfiguration': {
        'Destination': {
            'S3BucketDestination': {
                'AccountId': 'string',
                'Bucket': 'string',
                'Format': 'CSV'|'ORC'|'Parquet',
                'Prefix': 'string',
                'Encryption': {
                    'SSES3': {},
                    'SSEKMS': {
                        'KeyId': 'string'
                    }
                }
            }
        },
        'IsEnabled': True|False,
        'Filter': {
            'Prefix': 'string'
        },
        'Id': 'string',
        'IncludedObjectVersions': 'All'|'Current',
        'OptionalFields': [
            'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipartUploaded'|'ReplicationStatus'|'EncryptionStatus'|'ObjectLockRetainUntilDate'|'ObjectLockMode'|'ObjectLockLegalHoldStatus'|'IntelligentTieringAccessTier'|'BucketKeyStatus'|'ChecksumAlgorithm',
        ],
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    }
}

Response Structure

• (dict) --

  • InventoryConfiguration (dict) --

    Specifies the inventory configuration.

    • Destination (dict) --

      Contains information about where to publish the inventory results.

      • S3BucketDestination (dict) --

        Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

        • AccountId (string) --

          The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

          Note

          Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

        • Bucket (string) --

          The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

        • Format (string) --

          Specifies the output format of the inventory results.

        • Prefix (string) --

          The prefix that is prepended to all inventory results.

        • Encryption (dict) --

          Contains the type of server-side encryption used to encrypt the inventory results.

          • SSES3 (dict) --

            Specifies the use of SSE-S3 to encrypt delivered inventory reports.

          • SSEKMS (dict) --

            Specifies the use of SSE-KMS to encrypt delivered inventory reports.

            • KeyId (string) --

              Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

    • IsEnabled (boolean) --

      Specifies whether the inventory is enabled or disabled. If set to True , an inventory list is generated. If set to False , no inventory list is generated.

    • Filter (dict) --

      Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

      • Prefix (string) --

        The prefix that an object must have to be included in the inventory results.

    • Id (string) --

      The ID used to identify the inventory configuration.

    • IncludedObjectVersions (string) --

      Object versions to include in the inventory list. If set to All , the list includes all the object versions, which adds the version-related fields VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the list does not contain these version-related fields.

    • OptionalFields (list) --

      Contains the optional fields that are included in the inventory results.

      • (string) --

    • Schedule (dict) --

      Specifies the schedule for generating inventory results.

      • Frequency (string) --

        Specifies how frequently inventory results are produced.

{'ChecksumMode': 'ENABLED'}

{'ChecksumCRC32': 'string',
 'ChecksumCRC32C': 'string',
 'ChecksumSHA1': 'string',
 'ChecksumSHA256': 'string'}

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 .

For more information about returning the ACL of an object, see GetObjectAcl .

If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject . Otherwise, this action 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 KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

• x-amz-server-side-encryption-customer-algorithm

• x-amz-server-side-encryption-customer-key

• x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) .

Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy . If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

• If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error.

• If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.

Versioning

By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.

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.

• 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

See also: AWS API Documentation

Request Syntax

client.get_object(
    Bucket='string',
    IfMatch='string',
    IfModifiedSince=datetime(2015, 1, 1),
    IfNoneMatch='string',
    IfUnmodifiedSince=datetime(2015, 1, 1),
    Key='string',
    Range='string',
    ResponseCacheControl='string',
    ResponseContentDisposition='string',
    ResponseContentEncoding='string',
    ResponseContentLanguage='string',
    ResponseContentType='string',
    ResponseExpires=datetime(2015, 1, 1),
    VersionId='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string',
    RequestPayer='requester',
    PartNumber=123,
    ExpectedBucketOwner='string',
    ChecksumMode='ENABLED'
)

type Bucket

string

param Bucket

[REQUIRED]

The bucket name containing the object.

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

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

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

type IfMatch

string

param IfMatch

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

type IfModifiedSince

datetime

param IfModifiedSince

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

type IfNoneMatch

string

param IfNoneMatch

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

type IfUnmodifiedSince

datetime

param IfUnmodifiedSince

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

type Key

string

param Key

[REQUIRED]

Key of the object to get.

type Range

string

param Range

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

Note

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

type ResponseCacheControl

string

param ResponseCacheControl

Sets the Cache-Control header of the response.

type ResponseContentDisposition

string

param ResponseContentDisposition

Sets the Content-Disposition header of the response

type ResponseContentEncoding

string

param ResponseContentEncoding

Sets the Content-Encoding header of the response.

type ResponseContentLanguage

string

param ResponseContentLanguage

Sets the Content-Language header of the response.

type ResponseContentType

string

param ResponseContentType

Sets the Content-Type header of the response.

type ResponseExpires

datetime

param ResponseExpires

Sets the Expires header of the response.

type VersionId

string

param VersionId

VersionId used to reference a specific version of the object.

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type PartNumber

integer

param PartNumber

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ChecksumMode

string

param ChecksumMode

To retrieve the checksum, this mode must be enabled.

rtype

dict

returns

Response Syntax

{
    'Body': StreamingBody(),
    'DeleteMarker': True|False,
    'AcceptRanges': 'string',
    'Expiration': 'string',
    'Restore': 'string',
    'LastModified': datetime(2015, 1, 1),
    'ContentLength': 123,
    'ETag': 'string',
    'ChecksumCRC32': 'string',
    'ChecksumCRC32C': 'string',
    'ChecksumSHA1': 'string',
    'ChecksumSHA256': 'string',
    'MissingMeta': 123,
    'VersionId': 'string',
    'CacheControl': 'string',
    'ContentDisposition': 'string',
    'ContentEncoding': 'string',
    'ContentLanguage': 'string',
    'ContentRange': 'string',
    'ContentType': 'string',
    'Expires': datetime(2015, 1, 1),
    'WebsiteRedirectLocation': 'string',
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'Metadata': {
        'string': 'string'
    },
    'SSECustomerAlgorithm': 'string',
    'SSECustomerKeyMD5': 'string',
    'SSEKMSKeyId': 'string',
    'BucketKeyEnabled': True|False,
    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    'RequestCharged': 'requester',
    'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA',
    'PartsCount': 123,
    'TagCount': 123,
    'ObjectLockMode': 'GOVERNANCE'|'COMPLIANCE',
    'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
    'ObjectLockLegalHoldStatus': 'ON'|'OFF'
}

Response Structure

• (dict) --

  • Body (:class:`.StreamingBody`) --

    Object data.

  • DeleteMarker (boolean) --

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

  • AcceptRanges (string) --

    Indicates that a range of bytes was specified.

  • Expiration (string) --

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

  • Restore (string) --

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

  • LastModified (datetime) --

    Creation date of the object.

  • ContentLength (integer) --

    Size of the body in bytes.

  • ETag (string) --

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

  • ChecksumCRC32 (string) --

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

  • ChecksumCRC32C (string) --

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

  • ChecksumSHA1 (string) --

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

  • ChecksumSHA256 (string) --

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

  • MissingMeta (integer) --

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

  • VersionId (string) --

    Version of the object.

  • CacheControl (string) --

    Specifies caching behavior along the request/reply chain.

  • ContentDisposition (string) --

    Specifies presentational information for the object.

  • ContentEncoding (string) --

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

  • ContentLanguage (string) --

    The language the content is in.

  • ContentRange (string) --

    The portion of the object returned in the response.

  • ContentType (string) --

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

  • Expires (datetime) --

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

  • WebsiteRedirectLocation (string) --

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

  • ServerSideEncryption (string) --

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

  • Metadata (dict) --

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

    • (string) --

      • (string) --

  • SSECustomerAlgorithm (string) --

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

  • SSECustomerKeyMD5 (string) --

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

  • SSEKMSKeyId (string) --

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

  • BucketKeyEnabled (boolean) --

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

  • StorageClass (string) --

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

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • ReplicationStatus (string) --

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

  • PartsCount (integer) --

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

  • TagCount (integer) --

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

  • ObjectLockMode (string) --

    The Object Lock mode currently in place for this object.

  • ObjectLockRetainUntilDate (datetime) --

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

  • ObjectLockLegalHoldStatus (string) --

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

{'ChecksumMode': 'ENABLED'}

{'ChecksumCRC32': 'string',
 'ChecksumCRC32C': 'string',
 'ChecksumSHA1': 'string',
 'ChecksumSHA256': 'string'}

The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

• x-amz-server-side-encryption-customer-algorithm

• x-amz-server-side-encryption-customer-key

• x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) .

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 relevant read object (or version) 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 actions are related to HeadObject :

• GetObject

• GetObjectAttributes

See also: AWS API Documentation

Request Syntax

client.head_object(
    Bucket='string',
    IfMatch='string',
    IfModifiedSince=datetime(2015, 1, 1),
    IfNoneMatch='string',
    IfUnmodifiedSince=datetime(2015, 1, 1),
    Key='string',
    Range='string',
    VersionId='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string',
    RequestPayer='requester',
    PartNumber=123,
    ExpectedBucketOwner='string',
    ChecksumMode='ENABLED'
)

type Bucket

string

param Bucket

[REQUIRED]

The name of the bucket containing the object.

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

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

type IfMatch

string

param IfMatch

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

type IfModifiedSince

datetime

param IfModifiedSince

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

type IfNoneMatch

string

param IfNoneMatch

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

type IfUnmodifiedSince

datetime

param IfUnmodifiedSince

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

type Key

string

param Key

[REQUIRED]

The object key.

type Range

string

param Range

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

type VersionId

string

param VersionId

VersionId used to reference a specific version of the object.

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type PartNumber

integer

param PartNumber

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ChecksumMode

string

param ChecksumMode

To retrieve the checksum, this parameter must be enabled.

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

rtype

dict

returns

Response Syntax

{
    'DeleteMarker': True|False,
    'AcceptRanges': 'string',
    'Expiration': 'string',
    'Restore': 'string',
    'ArchiveStatus': 'ARCHIVE_ACCESS'|'DEEP_ARCHIVE_ACCESS',
    'LastModified': datetime(2015, 1, 1),
    'ContentLength': 123,
    'ChecksumCRC32': 'string',
    'ChecksumCRC32C': 'string',
    'ChecksumSHA1': 'string',
    'ChecksumSHA256': 'string',
    'ETag': 'string',
    'MissingMeta': 123,
    'VersionId': 'string',
    'CacheControl': 'string',
    'ContentDisposition': 'string',
    'ContentEncoding': 'string',
    'ContentLanguage': 'string',
    'ContentType': 'string',
    'Expires': datetime(2015, 1, 1),
    'WebsiteRedirectLocation': 'string',
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'Metadata': {
        'string': 'string'
    },
    'SSECustomerAlgorithm': 'string',
    'SSECustomerKeyMD5': 'string',
    'SSEKMSKeyId': 'string',
    'BucketKeyEnabled': True|False,
    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    'RequestCharged': 'requester',
    'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA',
    'PartsCount': 123,
    'ObjectLockMode': 'GOVERNANCE'|'COMPLIANCE',
    'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
    'ObjectLockLegalHoldStatus': 'ON'|'OFF'
}

Response Structure

• (dict) --

  • DeleteMarker (boolean) --

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

  • AcceptRanges (string) --

    Indicates that a range of bytes was specified.

  • Expiration (string) --

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

  • Restore (string) --

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

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

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

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

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

  • ArchiveStatus (string) --

    The archive state of the head object.

  • LastModified (datetime) --

    Creation date of the object.

  • ContentLength (integer) --

    Size of the body in bytes.

  • ChecksumCRC32 (string) --

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

  • ChecksumCRC32C (string) --

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

  • ChecksumSHA1 (string) --

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

  • ChecksumSHA256 (string) --

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

  • ETag (string) --

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

  • MissingMeta (integer) --

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

  • VersionId (string) --

    Version of the object.

  • CacheControl (string) --

    Specifies caching behavior along the request/reply chain.

  • ContentDisposition (string) --

    Specifies presentational information for the object.

  • ContentEncoding (string) --

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

  • ContentLanguage (string) --

    The language the content is in.

  • ContentType (string) --

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

  • Expires (datetime) --

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

  • WebsiteRedirectLocation (string) --

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

  • ServerSideEncryption (string) --

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

  • Metadata (dict) --

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

    • (string) --

      • (string) --

  • SSECustomerAlgorithm (string) --

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

  • SSECustomerKeyMD5 (string) --

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

  • SSEKMSKeyId (string) --

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

  • BucketKeyEnabled (boolean) --

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

  • StorageClass (string) --

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

    For more information, see Storage Classes .

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • ReplicationStatus (string) --

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

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

    • If requesting an object from the source bucket , Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication. For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs . Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf , are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

    • If requesting an object from a destination bucket , Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

    • When replicating objects to multiple destination buckets , the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

    For more information, see Replication .

  • PartsCount (integer) --

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

  • ObjectLockMode (string) --

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

  • ObjectLockRetainUntilDate (datetime) --

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

  • ObjectLockLegalHoldStatus (string) --

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

{'InventoryConfigurationList': {'OptionalFields': {'ChecksumAlgorithm'}}}

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

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken . You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations 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

See also: AWS API Documentation

Request Syntax

client.list_bucket_inventory_configurations(
    Bucket='string',
    ContinuationToken='string',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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

type ContinuationToken

string

param ContinuationToken

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'ContinuationToken': 'string',
    'InventoryConfigurationList': [
        {
            'Destination': {
                'S3BucketDestination': {
                    'AccountId': 'string',
                    'Bucket': 'string',
                    'Format': 'CSV'|'ORC'|'Parquet',
                    'Prefix': 'string',
                    'Encryption': {
                        'SSES3': {},
                        'SSEKMS': {
                            'KeyId': 'string'
                        }
                    }
                }
            },
            'IsEnabled': True|False,
            'Filter': {
                'Prefix': 'string'
            },
            'Id': 'string',
            'IncludedObjectVersions': 'All'|'Current',
            'OptionalFields': [
                'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipartUploaded'|'ReplicationStatus'|'EncryptionStatus'|'ObjectLockRetainUntilDate'|'ObjectLockMode'|'ObjectLockLegalHoldStatus'|'IntelligentTieringAccessTier'|'BucketKeyStatus'|'ChecksumAlgorithm',
            ],
            'Schedule': {
                'Frequency': 'Daily'|'Weekly'
            }
        },
    ],
    'IsTruncated': True|False,
    'NextContinuationToken': 'string'
}

Response Structure

• (dict) --

  • ContinuationToken (string) --

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

  • InventoryConfigurationList (list) --

    The list of inventory configurations for a bucket.

    • (dict) --

      Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference .

      • Destination (dict) --

        Contains information about where to publish the inventory results.

        • S3BucketDestination (dict) --

          Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

          • AccountId (string) --

            The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

            Note

            Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

          • Bucket (string) --

            The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

          • Format (string) --

            Specifies the output format of the inventory results.

          • Prefix (string) --

            The prefix that is prepended to all inventory results.

          • Encryption (dict) --

            Contains the type of server-side encryption used to encrypt the inventory results.

            • SSES3 (dict) --

              Specifies the use of SSE-S3 to encrypt delivered inventory reports.

            • SSEKMS (dict) --

              Specifies the use of SSE-KMS to encrypt delivered inventory reports.

              • KeyId (string) --

                Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

      • IsEnabled (boolean) --

        Specifies whether the inventory is enabled or disabled. If set to True , an inventory list is generated. If set to False , no inventory list is generated.

      • Filter (dict) --

        Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

        • Prefix (string) --

          The prefix that an object must have to be included in the inventory results.

      • Id (string) --

        The ID used to identify the inventory configuration.

      • IncludedObjectVersions (string) --

        Object versions to include in the inventory list. If set to All , the list includes all the object versions, which adds the version-related fields VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the list does not contain these version-related fields.

      • OptionalFields (list) --

        Contains the optional fields that are included in the inventory results.

        • (string) --

      • Schedule (dict) --

        Specifies the schedule for generating inventory results.

        • Frequency (string) --

          Specifies how frequently inventory results are produced.

  • IsTruncated (boolean) --

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

  • NextContinuationToken (string) --

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

{'Uploads': {'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}}

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

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

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

The following operations are related to ListMultipartUploads :

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• AbortMultipartUpload

See also: AWS API Documentation

Request Syntax

client.list_multipart_uploads(
    Bucket='string',
    Delimiter='string',
    EncodingType='url',
    KeyMarker='string',
    MaxUploads=123,
    Prefix='string',
    UploadIdMarker='string',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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

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

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

type Delimiter

string

param Delimiter

Character you use to group keys.

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

type EncodingType

string

param EncodingType

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

type KeyMarker

string

param KeyMarker

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

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

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

type MaxUploads

integer

param MaxUploads

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

type Prefix

string

param Prefix

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

type UploadIdMarker

string

param UploadIdMarker

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'Bucket': 'string',
    'KeyMarker': 'string',
    'UploadIdMarker': 'string',
    'NextKeyMarker': 'string',
    'Prefix': 'string',
    'Delimiter': 'string',
    'NextUploadIdMarker': 'string',
    'MaxUploads': 123,
    'IsTruncated': True|False,
    'Uploads': [
        {
            'UploadId': 'string',
            'Key': 'string',
            'Initiated': datetime(2015, 1, 1),
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'Initiator': {
                'ID': 'string',
                'DisplayName': 'string'
            },
            'ChecksumAlgorithm': 'CRC32'|'CRC32C'|'SHA1'|'SHA256'
        },
    ],
    'CommonPrefixes': [
        {
            'Prefix': 'string'
        },
    ],
    'EncodingType': 'url'
}

Response Structure

• (dict) --

  • Bucket (string) --

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

  • KeyMarker (string) --

    The key at or after which the listing began.

  • UploadIdMarker (string) --

    Upload ID after which listing began.

  • NextKeyMarker (string) --

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

  • Prefix (string) --

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

  • Delimiter (string) --

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

  • NextUploadIdMarker (string) --

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

  • MaxUploads (integer) --

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

  • IsTruncated (boolean) --

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

  • Uploads (list) --

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

    • (dict) --

      Container for the MultipartUpload for the Amazon S3 object.

      • UploadId (string) --

        Upload ID that identifies the multipart upload.

      • Key (string) --

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

      • Initiated (datetime) --

        Date and time at which the multipart upload was initiated.

      • StorageClass (string) --

        The class of storage used to store the object.

      • Owner (dict) --

        Specifies the owner of the object that is part of the multipart upload.

        • DisplayName (string) --

          Container for the display name of the owner.

        • ID (string) --

          Container for the ID of the owner.

      • Initiator (dict) --

        Identifies who initiated the multipart upload.

        • ID (string) --

          If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

        • DisplayName (string) --

          Name of the Principal.

      • ChecksumAlgorithm (string) --

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

  • CommonPrefixes (list) --

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

    • (dict) --

      Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

      • Prefix (string) --

        Container for the specified common prefix.

  • EncodingType (string) --

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

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

    Delimiter , KeyMarker , Prefix , NextKeyMarker , Key .

{'Versions': {'ChecksumAlgorithm': ['CRC32 | CRC32C | SHA1 | SHA256']}}

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have 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

See also: AWS API Documentation

Request Syntax

client.list_object_versions(
    Bucket='string',
    Delimiter='string',
    EncodingType='url',
    KeyMarker='string',
    MaxKeys=123,
    Prefix='string',
    VersionIdMarker='string',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

The bucket name that contains the objects.

type Delimiter

string

param Delimiter

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

type EncodingType

string

param EncodingType

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

type KeyMarker

string

param KeyMarker

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

type MaxKeys

integer

param MaxKeys

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

type Prefix

string

param Prefix

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.

type VersionIdMarker

string

param VersionIdMarker

Specifies the object version you want to start listing from.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'IsTruncated': True|False,
    'KeyMarker': 'string',
    'VersionIdMarker': 'string',
    'NextKeyMarker': 'string',
    'NextVersionIdMarker': 'string',
    'Versions': [
        {
            'ETag': 'string',
            'ChecksumAlgorithm': [
                'CRC32'|'CRC32C'|'SHA1'|'SHA256',
            ],
            'Size': 123,
            'StorageClass': 'STANDARD',
            'Key': 'string',
            'VersionId': 'string',
            'IsLatest': True|False,
            'LastModified': datetime(2015, 1, 1),
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        },
    ],
    'DeleteMarkers': [
        {
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'Key': 'string',
            'VersionId': 'string',
            'IsLatest': True|False,
            'LastModified': datetime(2015, 1, 1)
        },
    ],
    'Name': 'string',
    'Prefix': 'string',
    'Delimiter': 'string',
    'MaxKeys': 123,
    'CommonPrefixes': [
        {
            'Prefix': 'string'
        },
    ],
    'EncodingType': 'url'
}

Response Structure

• (dict) --

  • IsTruncated (boolean) --

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

  • KeyMarker (string) --

    Marks the last key returned in a truncated response.

  • VersionIdMarker (string) --

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

  • NextKeyMarker (string) --

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

  • NextVersionIdMarker (string) --

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

  • Versions (list) --

    Container for version information.

    • (dict) --

      The version of an object.

      • ETag (string) --

        The entity tag is an MD5 hash of that version of the object.

      • ChecksumAlgorithm (list) --

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

        • (string) --

      • Size (integer) --

        Size in bytes of the object.

      • StorageClass (string) --

        The class of storage used to store the object.

      • Key (string) --

        The object key.

      • VersionId (string) --

        Version ID of an object.

      • IsLatest (boolean) --

        Specifies whether the object is (true) or is not (false) the latest version of an object.

      • LastModified (datetime) --

        Date and time the object was last modified.

      • Owner (dict) --

        Specifies the owner of the object.

        • DisplayName (string) --

          Container for the display name of the owner.

        • ID (string) --

          Container for the ID of the owner.

  • DeleteMarkers (list) --

    Container for an object that is a delete marker.

    • (dict) --

      Information about the delete marker.

      • Owner (dict) --

        The account that created the delete marker.>

        • DisplayName (string) --

          Container for the display name of the owner.

        • ID (string) --

          Container for the ID of the owner.

      • Key (string) --

        The object key.

      • VersionId (string) --

        Version ID of an object.

      • IsLatest (boolean) --

        Specifies whether the object is (true) or is not (false) the latest version of an object.

      • LastModified (datetime) --

        Date and time the object was last modified.

  • Name (string) --

    The bucket name.

  • Prefix (string) --

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

  • Delimiter (string) --

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

  • MaxKeys (integer) --

    Specifies the maximum number of objects to return.

  • CommonPrefixes (list) --

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

    • (dict) --

      Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

      • Prefix (string) --

        Container for the specified common prefix.

  • EncodingType (string) --

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

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

    KeyMarker, NextKeyMarker, Prefix, Key , and Delimiter .

{'Contents': {'ChecksumAlgorithm': ['CRC32 | CRC32C | SHA1 | SHA256']}}

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.

The following operations are related to ListObjects :

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

See also: AWS API Documentation

Request Syntax

client.list_objects(
    Bucket='string',
    Delimiter='string',
    EncodingType='url',
    Marker='string',
    MaxKeys=123,
    Prefix='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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 .

type Delimiter

string

param Delimiter

A delimiter is a character you use to group keys.

type EncodingType

string

param EncodingType

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

type Marker

string

param Marker

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.

type MaxKeys

integer

param MaxKeys

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.

type Prefix

string

param Prefix

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'IsTruncated': True|False,
    'Marker': 'string',
    'NextMarker': 'string',
    'Contents': [
        {
            'Key': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ETag': 'string',
            'ChecksumAlgorithm': [
                'CRC32'|'CRC32C'|'SHA1'|'SHA256',
            ],
            'Size': 123,
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        },
    ],
    'Name': 'string',
    'Prefix': 'string',
    'Delimiter': 'string',
    'MaxKeys': 123,
    'CommonPrefixes': [
        {
            'Prefix': 'string'
        },
    ],
    'EncodingType': 'url'
}

Response Structure

• (dict) --

  • IsTruncated (boolean) --

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

  • Marker (string) --

    Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

  • NextMarker (string) --

    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

  • Contents (list) --

    Metadata about each object returned.

    • (dict) --

      An object consists of data and its descriptive metadata.

      • Key (string) --

        The name that you assign to an object. You use the object key to retrieve the object.

      • LastModified (datetime) --

        Creation date of the object.

      • ETag (string) --

        The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

        • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

        • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

        • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

      • ChecksumAlgorithm (list) --

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

        • (string) --

      • Size (integer) --

        Size in bytes of the object

      • StorageClass (string) --

        The class of storage used to store the object.

      • Owner (dict) --

        The owner of the object

        • DisplayName (string) --

          Container for the display name of the owner.

        • ID (string) --

          Container for the ID of the owner.

  • Name (string) --

    The bucket name.

  • Prefix (string) --

    Keys that begin with the indicated prefix.

  • Delimiter (string) --

    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

  • MaxKeys (integer) --

    The maximum number of keys returned in the response body.

  • CommonPrefixes (list) --

    All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

    A response can contain CommonPrefixes only if you specify a delimiter.

    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    • (dict) --

      Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

      • Prefix (string) --

        Container for the specified common prefix.

  • EncodingType (string) --

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

{'Contents': {'ChecksumAlgorithm': ['CRC32 | CRC32C | SHA1 | SHA256']}}

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources .

To get a list of your buckets, see ListBuckets .

The following operations are related to ListObjectsV2 :

• GetObject

• PutObject

• CreateBucket

See also: AWS API Documentation

Request Syntax

client.list_objects_v2(
    Bucket='string',
    Delimiter='string',
    EncodingType='url',
    MaxKeys=123,
    Prefix='string',
    ContinuationToken='string',
    FetchOwner=True|False,
    StartAfter='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

Bucket name to list.

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

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

type Delimiter

string

param Delimiter

A delimiter is a character you use to group keys.

type EncodingType

string

param EncodingType

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

type MaxKeys

integer

param MaxKeys

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.

type Prefix

string

param Prefix

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

type ContinuationToken

string

param ContinuationToken

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

type FetchOwner

boolean

param FetchOwner

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

type StartAfter

string

param StartAfter

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

rtype

dict

returns

Response Syntax

{
    'IsTruncated': True|False,
    'Contents': [
        {
            'Key': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ETag': 'string',
            'ChecksumAlgorithm': [
                'CRC32'|'CRC32C'|'SHA1'|'SHA256',
            ],
            'Size': 123,
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        },
    ],
    'Name': 'string',
    'Prefix': 'string',
    'Delimiter': 'string',
    'MaxKeys': 123,
    'CommonPrefixes': [
        {
            'Prefix': 'string'
        },
    ],
    'EncodingType': 'url',
    'KeyCount': 123,
    'ContinuationToken': 'string',
    'NextContinuationToken': 'string',
    'StartAfter': 'string'
}

Response Structure

• (dict) --

  • IsTruncated (boolean) --

    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

  • Contents (list) --

    Metadata about each object returned.

    • (dict) --

      An object consists of data and its descriptive metadata.

      • Key (string) --

        The name that you assign to an object. You use the object key to retrieve the object.

      • LastModified (datetime) --

        Creation date of the object.

      • ETag (string) --

        The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

        • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

        • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

        • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

      • ChecksumAlgorithm (list) --

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

        • (string) --

      • Size (integer) --

        Size in bytes of the object

      • StorageClass (string) --

        The class of storage used to store the object.

      • Owner (dict) --

        The owner of the object

        • DisplayName (string) --

          Container for the display name of the owner.

        • ID (string) --

          Container for the ID of the owner.

  • Name (string) --

    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 .

  • Prefix (string) --

    Keys that begin with the indicated prefix.

  • Delimiter (string) --

    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

  • MaxKeys (integer) --

    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.

  • CommonPrefixes (list) --

    All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

    A response can contain CommonPrefixes only if you specify a delimiter.

    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix .

    For example, if the prefix is notes/ and the delimiter is a slash (/ ) as in notes/summer/july , the common prefix is notes/summer/ . All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    • (dict) --

      Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

      • Prefix (string) --

        Container for the specified common prefix.

  • EncodingType (string) --

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

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

    Delimiter, Prefix, Key, and StartAfter .

  • KeyCount (integer) --

    KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

  • ContinuationToken (string) --

    If ContinuationToken was sent with the request, it is included in the response.

  • NextContinuationToken (string) --

    NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken . NextContinuationToken is obfuscated and is not a real key

  • StartAfter (string) --

    If StartAfter was sent with the request, it is included in the response.

{'SSECustomerAlgorithm': 'string',
 'SSECustomerKey': 'blob',
 'SSECustomerKeyMD5': 'string'}

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256',
 'Parts': {'ChecksumCRC32': 'string',
           'ChecksumCRC32C': 'string',
           'ChecksumSHA1': 'string',
           'ChecksumSHA256': 'string'}}

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.

If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed.

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

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

The following operations are related to ListParts :

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• AbortMultipartUpload

• GetObjectAttributes

• ListMultipartUploads

See also: AWS API Documentation

Request Syntax

client.list_parts(
    Bucket='string',
    Key='string',
    MaxParts=123,
    PartNumberMarker=123,
    UploadId='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey=b'bytes',
    SSECustomerKeyMD5='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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 .

type Key

string

param Key

[REQUIRED]

Object key for which the multipart upload was initiated.

type MaxParts

integer

param MaxParts

Sets the maximum number of parts to return.

type PartNumberMarker

integer

param PartNumberMarker

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

type UploadId

string

param UploadId

[REQUIRED]

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

type RequestPayer

string

param RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type SSECustomerAlgorithm

string

param SSECustomerAlgorithm

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

type SSECustomerKey

bytes

param SSECustomerKey

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

type SSECustomerKeyMD5

string

param SSECustomerKeyMD5

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

rtype

dict

returns

Response Syntax

{
    'AbortDate': datetime(2015, 1, 1),
    'AbortRuleId': 'string',
    'Bucket': 'string',
    'Key': 'string',
    'UploadId': 'string',
    'PartNumberMarker': 123,
    'NextPartNumberMarker': 123,
    'MaxParts': 123,
    'IsTruncated': True|False,
    'Parts': [
        {
            'PartNumber': 123,
            'LastModified': datetime(2015, 1, 1),
            'ETag': 'string',
            'Size': 123,
            'ChecksumCRC32': 'string',
            'ChecksumCRC32C': 'string',
            'ChecksumSHA1': 'string',
            'ChecksumSHA256': 'string'
        },
    ],
    'Initiator': {
        'ID': 'string',
        'DisplayName': 'string'
    },
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    },
    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR',
    'RequestCharged': 'requester',
    'ChecksumAlgorithm': 'CRC32'|'CRC32C'|'SHA1'|'SHA256'
}

Response Structure

• (dict) --

  • AbortDate (datetime) --

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

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

  • AbortRuleId (string) --

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

  • Bucket (string) --

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

  • Key (string) --

    Object key for which the multipart upload was initiated.

  • UploadId (string) --

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

  • PartNumberMarker (integer) --

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

  • NextPartNumberMarker (integer) --

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

  • MaxParts (integer) --

    Maximum number of parts that were allowed in the response.

  • IsTruncated (boolean) --

    Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

  • Parts (list) --

    Container for elements related to a particular part. A response can contain zero or more Part elements.

    • (dict) --

      Container for elements related to a part.

      • PartNumber (integer) --

        Part number identifying the part. This is a positive integer between 1 and 10,000.

      • LastModified (datetime) --

        Date and time at which the part was uploaded.

      • ETag (string) --

        Entity tag returned when the part was uploaded.

      • Size (integer) --

        Size in bytes of the uploaded part data.

      • ChecksumCRC32 (string) --

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

      • ChecksumCRC32C (string) --

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

      • ChecksumSHA1 (string) --

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

      • ChecksumSHA256 (string) --

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

  • Initiator (dict) --

    Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

    • ID (string) --

      If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

    • DisplayName (string) --

      Name of the Principal.

  • Owner (dict) --

    Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

    • DisplayName (string) --

      Container for the display name of the owner.

    • ID (string) --

      Container for the ID of the owner.

  • StorageClass (string) --

    Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

  • ChecksumAlgorithm (string) --

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

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

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 action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration .

The following operations are related to PutBucketAccelerateConfiguration :

• GetBucketAccelerateConfiguration

• CreateBucket

See also: AWS API Documentation

Request Syntax

client.put_bucket_accelerate_configuration(
    Bucket='string',
    AccelerateConfiguration={
        'Status': 'Enabled'|'Suspended'
    },
    ExpectedBucketOwner='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'
)

type Bucket

string

param Bucket

[REQUIRED]

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

type AccelerateConfiguration

dict

param AccelerateConfiguration

[REQUIRED]

Container for setting the transfer acceleration state.

• Status (string) --

  Specifies the transfer acceleration status of the bucket.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs . To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

• Specify the ACL in the request body

• Specify permissions using request headers

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

You can set access permissions using one of the following methods:

• Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs . Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl . If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL .

• Specify access permissions explicitly with the x-amz-grant-read , x-amz-grant-read-acp , x-amz-grant-write-acp , and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview . You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

  Note

  Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

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

For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

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

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

• By the person's ID: <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 URI: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

• By Email address: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

• CreateBucket

• DeleteBucket

• GetObjectAcl

See also: AWS API Documentation

Request Syntax

client.put_bucket_acl(
    ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
    AccessControlPolicy={
        'Grants': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'EmailAddress': 'string',
                    'ID': 'string',
                    'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ'|'READ_ACP'
            },
        ],
        'Owner': {
            'DisplayName': 'string',
            'ID': 'string'
        }
    },
    Bucket='string',
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    GrantFullControl='string',
    GrantRead='string',
    GrantReadACP='string',
    GrantWrite='string',
    GrantWriteACP='string',
    ExpectedBucketOwner='string'
)

type ACL

string

param ACL

The canned ACL to apply to the bucket.

type AccessControlPolicy

dict

param AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.

• Grants (list) --

  A list of grants.

  • (dict) --

    Container for grant information.

    • Grantee (dict) --

      The person being granted permissions.

      • DisplayName (string) --

        Screen name of the grantee.

      • EmailAddress (string) --

        Email address of the grantee.

        Note

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        • US East (N. Virginia)

        • US West (N. California)

        • US West (Oregon)

        • Asia Pacific (Singapore)

        • Asia Pacific (Sydney)

        • Asia Pacific (Tokyo)

        • Europe (Ireland)

        • South America (São Paulo)

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

      • ID (string) --

        The canonical user ID of the grantee.

      • Type (string) -- [REQUIRED]

        Type of grantee

      • URI (string) --

        URI of the grantee group.

    • Permission (string) --

      Specifies the permission given to the grantee.

• Owner (dict) --

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

  • DisplayName (string) --

    Container for the display name of the owner.

  • ID (string) --

    Container for the ID of the owner.

type Bucket

string

param Bucket

[REQUIRED]

The bucket to which to apply the ACL.

type ContentMD5

string

param ContentMD5

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type GrantFullControl

string

param GrantFullControl

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

type GrantRead

string

param GrantRead

Allows grantee to list the objects in the bucket.

type GrantReadACP

string

param GrantReadACP

Allows grantee to read the bucket ACL.

type GrantWrite

string

param GrantWrite

Allows grantee to create new objects in the bucket.

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

type GrantWriteACP

string

param GrantWriteACP

Allows grantee to write the ACL for the applicable bucket.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

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

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

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

• The request's Origin header must match AllowedOrigin elements.

• The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.

• Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

Related Resources

• GetBucketCors

• DeleteBucketCors

• RESTOPTIONSobject

See also: AWS API Documentation

Request Syntax

client.put_bucket_cors(
    Bucket='string',
    CORSConfiguration={
        'CORSRules': [
            {
                'ID': 'string',
                'AllowedHeaders': [
                    'string',
                ],
                'AllowedMethods': [
                    'string',
                ],
                'AllowedOrigins': [
                    'string',
                ],
                'ExposeHeaders': [
                    'string',
                ],
                'MaxAgeSeconds': 123
            },
        ]
    },
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

Specifies the bucket impacted by the cors configuration.

type CORSConfiguration

dict

param CORSConfiguration

[REQUIRED]

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

• CORSRules (list) -- [REQUIRED]

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

  • (dict) --

    Specifies a cross-origin access rule for an Amazon S3 bucket.

    • ID (string) --

      Unique identifier for the rule. The value cannot be longer than 255 characters.

    • AllowedHeaders (list) --

      Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

      • (string) --

    • AllowedMethods (list) -- [REQUIRED]

      An HTTP method that you allow the origin to execute. Valid values are GET , PUT , HEAD , POST , and DELETE .

      • (string) --

    • AllowedOrigins (list) -- [REQUIRED]

      One or more origins you want customers to be able to access the bucket from.

      • (string) --

    • ExposeHeaders (list) --

      One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

      • (string) --

    • MaxAgeSeconds (integer) --

      The time in seconds that your browser is to cache the preflight response for the specified resource.

type ContentMD5

string

param ContentMD5

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

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

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide . For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide .

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Related Resources

• GetBucketEncryption

• DeleteBucketEncryption

See also: AWS API Documentation

Request Syntax

client.put_bucket_encryption(
    Bucket='string',
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ServerSideEncryptionConfiguration={
        'Rules': [
            {
                'ApplyServerSideEncryptionByDefault': {
                    'SSEAlgorithm': 'AES256'|'aws:kms',
                    'KMSMasterKeyID': 'string'
                },
                'BucketKeyEnabled': True|False
            },
        ]
    },
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide .

type ContentMD5

string

param ContentMD5

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type ServerSideEncryptionConfiguration

dict

param ServerSideEncryptionConfiguration

[REQUIRED]

Specifies the default server-side-encryption configuration.

• Rules (list) -- [REQUIRED]

  Container for information about a particular server-side encryption configuration rule.

  • (dict) --

    Specifies the default server-side encryption configuration.

    • ApplyServerSideEncryptionByDefault (dict) --

      Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

      • SSEAlgorithm (string) -- [REQUIRED]

        Server-side encryption algorithm to use for the default encryption.

      • KMSMasterKeyID (string) --

        Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms .

        You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations .

        For example:

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

        Warning

        Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide .

    • BucketKeyEnabled (boolean) --

      Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

      For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide .

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'InventoryConfiguration': {'OptionalFields': {'ChecksumAlgorithm'}}}

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

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Special Errors

• HTTP 400 Bad Request Error

  • Code: InvalidArgument

  • Cause: Invalid Argument

• HTTP 400 Bad Request Error

  • Code: TooManyConfigurations

  • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

• HTTP 403 Forbidden Error

  • Code: AccessDenied

  • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

Related Resources

• GetBucketInventoryConfiguration

• DeleteBucketInventoryConfiguration

• ListBucketInventoryConfigurations

See also: AWS API Documentation

Request Syntax

client.put_bucket_inventory_configuration(
    Bucket='string',
    Id='string',
    InventoryConfiguration={
        'Destination': {
            'S3BucketDestination': {
                'AccountId': 'string',
                'Bucket': 'string',
                'Format': 'CSV'|'ORC'|'Parquet',
                'Prefix': 'string',
                'Encryption': {
                    'SSES3': {}
                    ,
                    'SSEKMS': {
                        'KeyId': 'string'
                    }
                }
            }
        },
        'IsEnabled': True|False,
        'Filter': {
            'Prefix': 'string'
        },
        'Id': 'string',
        'IncludedObjectVersions': 'All'|'Current',
        'OptionalFields': [
            'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipartUploaded'|'ReplicationStatus'|'EncryptionStatus'|'ObjectLockRetainUntilDate'|'ObjectLockMode'|'ObjectLockLegalHoldStatus'|'IntelligentTieringAccessTier'|'BucketKeyStatus'|'ChecksumAlgorithm',
        ],
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    },
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

The name of the bucket where the inventory configuration will be stored.

type Id

string

param Id

[REQUIRED]

The ID used to identify the inventory configuration.

type InventoryConfiguration

dict

param InventoryConfiguration

[REQUIRED]

Specifies the inventory configuration.

• Destination (dict) -- [REQUIRED]

  Contains information about where to publish the inventory results.

  • S3BucketDestination (dict) -- [REQUIRED]

    Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

    • AccountId (string) --

      The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

      Note

      Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

    • Bucket (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

    • Format (string) -- [REQUIRED]

      Specifies the output format of the inventory results.

    • Prefix (string) --

      The prefix that is prepended to all inventory results.

    • Encryption (dict) --

      Contains the type of server-side encryption used to encrypt the inventory results.

      • SSES3 (dict) --

        Specifies the use of SSE-S3 to encrypt delivered inventory reports.

      • SSEKMS (dict) --

        Specifies the use of SSE-KMS to encrypt delivered inventory reports.

        • KeyId (string) -- [REQUIRED]

          Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

• IsEnabled (boolean) -- [REQUIRED]

  Specifies whether the inventory is enabled or disabled. If set to True , an inventory list is generated. If set to False , no inventory list is generated.

• Filter (dict) --

  Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

  • Prefix (string) -- [REQUIRED]

    The prefix that an object must have to be included in the inventory results.

• Id (string) -- [REQUIRED]

  The ID used to identify the inventory configuration.

• IncludedObjectVersions (string) -- [REQUIRED]

  Object versions to include in the inventory list. If set to All , the list includes all the object versions, which adds the version-related fields VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the list does not contain these version-related fields.

• OptionalFields (list) --

  Contains the optional fields that are included in the inventory results.

  • (string) --

• Schedule (dict) -- [REQUIRED]

  Specifies the schedule for generating inventory results.

  • Frequency (string) -- [REQUIRED]

    Specifies how frequently inventory results are produced.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide .

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent 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 in the Amazon S3 User Guide .

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration .

Related Resources

• GetBucketLifecycle (Deprecated)

• GetBucketLifecycleConfiguration

• RestoreObject

• By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:

  • Specifying Permissions in a Policy

  • Managing Access Permissions to your Amazon S3 Resources

See also: AWS API Documentation

Request Syntax

client.put_bucket_lifecycle(
    Bucket='string',
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    LifecycleConfiguration={
        'Rules': [
            {
                'Expiration': {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'ExpiredObjectDeleteMarker': True|False
                },
                'ID': 'string',
                'Prefix': 'string',
                'Status': 'Enabled'|'Disabled',
                'Transition': {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR'
                },
                'NoncurrentVersionTransition': {
                    'NoncurrentDays': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR',
                    'NewerNoncurrentVersions': 123
                },
                'NoncurrentVersionExpiration': {
                    'NoncurrentDays': 123,
                    'NewerNoncurrentVersions': 123
                },
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 123
                }
            },
        ]
    },
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

type ContentMD5

string

param ContentMD5

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type LifecycleConfiguration

dict

param LifecycleConfiguration

• Rules (list) -- [REQUIRED]

  Specifies lifecycle configuration rules for an Amazon S3 bucket.

  • (dict) --

    Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference . For examples, see Put Bucket Lifecycle Configuration Examples .

    • Expiration (dict) --

      Specifies the expiration for the lifecycle of the object.

      • Date (datetime) --

        Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

      • Days (integer) --

        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

      • ExpiredObjectDeleteMarker (boolean) --

        Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

    • ID (string) --

      Unique identifier for the rule. The value can't be longer than 255 characters.

    • Prefix (string) -- [REQUIRED]

      Object key prefix that identifies one or more objects to which this rule applies.

      Warning

      Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints .

    • Status (string) -- [REQUIRED]

      If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.

    • Transition (dict) --

      Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide .

      • Date (datetime) --

        Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

      • Days (integer) --

        Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

      • StorageClass (string) --

        The storage class to which you want the object to transition.

    • NoncurrentVersionTransition (dict) --

      Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

      • NoncurrentDays (integer) --

        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide .

      • StorageClass (string) --

        The class of storage used to store the object.

      • NewerNoncurrentVersions (integer) --

        Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide .

    • NoncurrentVersionExpiration (dict) --

      Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

      • NoncurrentDays (integer) --

        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide .

      • NewerNoncurrentVersions (integer) --

        Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide .

    • AbortIncompleteMultipartUpload (dict) --

      Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide .

      • DaysAfterInitiation (integer) --

        Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

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 .

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 Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

• s3:DeleteObject

• s3:DeleteObjectVersion

• s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources .

The following are related to PutBucketLifecycleConfiguration :

• Examples of Lifecycle Configuration

• GetBucketLifecycleConfiguration

• DeleteBucketLifecycle

See also: AWS API Documentation

Request Syntax

client.put_bucket_lifecycle_configuration(
    Bucket='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    LifecycleConfiguration={
        'Rules': [
            {
                'Expiration': {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'ExpiredObjectDeleteMarker': True|False
                },
                'ID': 'string',
                'Prefix': 'string',
                'Filter': {
                    'Prefix': 'string',
                    'Tag': {
                        'Key': 'string',
                        'Value': 'string'
                    },
                    'ObjectSizeGreaterThan': 123,
                    'ObjectSizeLessThan': 123,
                    'And': {
                        'Prefix': 'string',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'ObjectSizeGreaterThan': 123,
                        'ObjectSizeLessThan': 123
                    }
                },
                'Status': 'Enabled'|'Disabled',
                'Transitions': [
                    {
                        'Date': datetime(2015, 1, 1),
                        'Days': 123,
                        'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR'
                    },
                ],
                'NoncurrentVersionTransitions': [
                    {
                        'NoncurrentDays': 123,
                        'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'GLACIER_IR',
                        'NewerNoncurrentVersions': 123
                    },
                ],
                'NoncurrentVersionExpiration': {
                    'NoncurrentDays': 123,
                    'NewerNoncurrentVersions': 123
                },
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 123
                }
            },
        ]
    },
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

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

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type LifecycleConfiguration

dict

param LifecycleConfiguration

Container for lifecycle rules. You can add as many as 1,000 rules.

• Rules (list) -- [REQUIRED]

  A lifecycle rule for individual objects in an Amazon S3 bucket.

  • (dict) --

    A lifecycle rule for individual objects in an Amazon S3 bucket.

    • Expiration (dict) --

      Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

      • Date (datetime) --

        Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

      • Days (integer) --

        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

      • ExpiredObjectDeleteMarker (boolean) --

        Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

    • ID (string) --

      Unique identifier for the rule. The value cannot be longer than 255 characters.

    • Prefix (string) --

      Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

      Warning

      Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints .

    • Filter (dict) --

      The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix , Tag , or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

      • Prefix (string) --

        Prefix identifying one or more objects to which the rule applies.

        Warning

        Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints .

      • Tag (dict) --

        This tag must exist in the object's tag set in order for the rule to apply.

        • Key (string) -- [REQUIRED]

          Name of the object key.

        • Value (string) -- [REQUIRED]

          Value of the tag.

      • ObjectSizeGreaterThan (integer) --

        Minimum object size to which the rule applies.

      • ObjectSizeLessThan (integer) --

        Maximum object size to which the rule applies.

      • And (dict) --

        This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

        • Prefix (string) --

          Prefix identifying one or more objects to which the rule applies.

        • Tags (list) --

          All of these tags must exist in the object's tag set in order for the rule to apply.

          • (dict) --

            A container of a key value name pair.

            • Key (string) -- [REQUIRED]

              Name of the object key.

            • Value (string) -- [REQUIRED]

              Value of the tag.

        • ObjectSizeGreaterThan (integer) --

          Minimum object size to which the rule applies.

        • ObjectSizeLessThan (integer) --

          Maximum object size to which the rule applies.

    • Status (string) -- [REQUIRED]

      If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

    • Transitions (list) --

      Specifies when an Amazon S3 object transitions to a specified storage class.

      • (dict) --

        Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide .

        • Date (datetime) --

          Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

        • Days (integer) --

          Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

        • StorageClass (string) --

          The storage class to which you want the object to transition.

    • NoncurrentVersionTransitions (list) --

      Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

      • (dict) --

        Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

        • NoncurrentDays (integer) --

          Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide .

        • StorageClass (string) --

          The class of storage used to store the object.

        • NewerNoncurrentVersions (integer) --

          Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide .

    • NoncurrentVersionExpiration (dict) --

      Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

      • NoncurrentDays (integer) --

        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide .

      • NewerNoncurrentVersions (integer) --

        Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide .

    • AbortIncompleteMultipartUpload (dict) --

      Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide .

      • DaysAfterInitiation (integer) --

        Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None

{'ChecksumAlgorithm': 'CRC32 | CRC32C | SHA1 | SHA256'}

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

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 in the Amazon S3 User Guide .

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

See also: AWS API Documentation

Request Syntax

client.put_bucket_logging(
    Bucket='string',
    BucketLoggingStatus={
        'LoggingEnabled': {
            'TargetBucket': 'string',
            'TargetGrants': [
                {
                    'Grantee': {
                        'DisplayName': 'string',
                        'EmailAddress': 'string',
                        'ID': 'string',
                        'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                        'URI': 'string'
                    },
                    'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
                },
            ],
            'TargetPrefix': 'string'
        }
    },
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ExpectedBucketOwner='string'
)

type Bucket

string

param Bucket

[REQUIRED]

The name of the bucket for which to set the logging parameters.

type BucketLoggingStatus

dict

param BucketLoggingStatus

[REQUIRED]

Container for logging status information.

• LoggingEnabled (dict) --

  Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference .

  • TargetBucket (string) -- [REQUIRED]

    Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

  • TargetGrants (list) --

    Container for granting information.

    Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide .

    • (dict) --

      Container for granting information.

      Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide .

      • Grantee (dict) --

        Container for the person being granted permissions.

        • DisplayName (string) --

          Screen name of the grantee.

        • EmailAddress (string) --

          Email address of the grantee.

          Note

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          • US East (N. Virginia)

          • US West (N. California)

          • US West (Oregon)

          • Asia Pacific (Singapore)

          • Asia Pacific (Sydney)

          • Asia Pacific (Tokyo)

          • Europe (Ireland)

          • South America (São Paulo)

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

        • ID (string) --

          The canonical user ID of the grantee.

        • Type (string) -- [REQUIRED]

          Type of grantee

        • URI (string) --

          URI of the grantee group.

      • Permission (string) --

        Logging permissions assigned to the grantee for the bucket.

  • TargetPrefix (string) -- [REQUIRED]

    A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

type ContentMD5

string

param ContentMD5

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

type ChecksumAlgorithm

string

param ChecksumAlgorithm

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

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

type ExpectedBucketOwner

string

param ExpectedBucketOwner

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

returns

None