

.. _How Amazon S3 Calculates When an Object Became Noncurrent: /AmazonS3/latest/dev/s3-access-control.html


**
S3
**

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: S3.Client

  A low-level client representing Amazon Simple Storage Service (S3)::

    
    import boto3
    
    client = boto3.client('s3')

  
  These are the available methods:
  
  *   :py:meth:`abort_multipart_upload`

  
  *   :py:meth:`can_paginate`

  
  *   :py:meth:`complete_multipart_upload`

  
  *   :py:meth:`copy_object`

  
  *   :py:meth:`create_bucket`

  
  *   :py:meth:`create_multipart_upload`

  
  *   :py:meth:`delete_bucket`

  
  *   :py:meth:`delete_bucket_cors`

  
  *   :py:meth:`delete_bucket_lifecycle`

  
  *   :py:meth:`delete_bucket_policy`

  
  *   :py:meth:`delete_bucket_replication`

  
  *   :py:meth:`delete_bucket_tagging`

  
  *   :py:meth:`delete_bucket_website`

  
  *   :py:meth:`delete_object`

  
  *   :py:meth:`delete_objects`

  
  *   :py:meth:`download_file`

  
  *   :py:meth:`generate_presigned_post`

  
  *   :py:meth:`generate_presigned_url`

  
  *   :py:meth:`get_bucket_acl`

  
  *   :py:meth:`get_bucket_cors`

  
  *   :py:meth:`get_bucket_lifecycle`

  
  *   :py:meth:`get_bucket_location`

  
  *   :py:meth:`get_bucket_logging`

  
  *   :py:meth:`get_bucket_notification`

  
  *   :py:meth:`get_bucket_notification_configuration`

  
  *   :py:meth:`get_bucket_policy`

  
  *   :py:meth:`get_bucket_replication`

  
  *   :py:meth:`get_bucket_request_payment`

  
  *   :py:meth:`get_bucket_tagging`

  
  *   :py:meth:`get_bucket_versioning`

  
  *   :py:meth:`get_bucket_website`

  
  *   :py:meth:`get_object`

  
  *   :py:meth:`get_object_acl`

  
  *   :py:meth:`get_object_torrent`

  
  *   :py:meth:`get_paginator`

  
  *   :py:meth:`get_waiter`

  
  *   :py:meth:`head_bucket`

  
  *   :py:meth:`head_object`

  
  *   :py:meth:`list_buckets`

  
  *   :py:meth:`list_multipart_uploads`

  
  *   :py:meth:`list_object_versions`

  
  *   :py:meth:`list_objects`

  
  *   :py:meth:`list_parts`

  
  *   :py:meth:`put_bucket_acl`

  
  *   :py:meth:`put_bucket_cors`

  
  *   :py:meth:`put_bucket_lifecycle`

  
  *   :py:meth:`put_bucket_logging`

  
  *   :py:meth:`put_bucket_notification`

  
  *   :py:meth:`put_bucket_notification_configuration`

  
  *   :py:meth:`put_bucket_policy`

  
  *   :py:meth:`put_bucket_replication`

  
  *   :py:meth:`put_bucket_request_payment`

  
  *   :py:meth:`put_bucket_tagging`

  
  *   :py:meth:`put_bucket_versioning`

  
  *   :py:meth:`put_bucket_website`

  
  *   :py:meth:`put_object`

  
  *   :py:meth:`put_object_acl`

  
  *   :py:meth:`restore_object`

  
  *   :py:meth:`upload_file`

  
  *   :py:meth:`upload_part`

  
  *   :py:meth:`upload_part_copy`

  

  .. py:method:: abort_multipart_upload(**kwargs)

    

    Aborts a multipart upload.

     

    To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

    

    **Request Syntax** 
    ::

      response = client.abort_multipart_upload(
          Bucket='string',
          Key='string',
          UploadId='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type UploadId: string
    :param UploadId: **[REQUIRED]** 

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: complete_multipart_upload(**kwargs)

    Completes a multipart upload by assembling previously uploaded parts.

    **Request Syntax** 
    ::

      response = client.complete_multipart_upload(
          Bucket='string',
          Key='string',
          MultipartUpload={
              'Parts': [
                  {
                      'ETag': 'string',
                      'PartNumber': 123
                  },
              ]
          },
          UploadId='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type MultipartUpload: dict
    :param MultipartUpload: 

    
      - **Parts** *(list) --* 

      
        - *(dict) --* 

        
          - **ETag** *(string) --* Entity tag returned when the part was uploaded.

          
          - **PartNumber** *(integer) --* Part number that identifies the part. This is a positive integer between 1 and 10,000.

          
        
    
    
    :type UploadId: string
    :param UploadId: **[REQUIRED]** 

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Location': 'string',
            'Bucket': 'string',
            'Key': 'string',
            'Expiration': 'string',
            'ETag': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'VersionId': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Location** *(string) --* 
        

        - **Bucket** *(string) --* 
        

        - **Key** *(string) --* 
        

        - **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 of the object.
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **VersionId** *(string) --* Version of the object.
        

        - **SSEKMSKeyId** *(string) --* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: copy_object(**kwargs)

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

    **Request Syntax** 
    ::

      response = client.copy_object(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          Bucket='string',
          CacheControl='string',
          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',
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          CopySourceSSECustomerAlgorithm='string',
          CopySourceSSECustomerKey='string',
          CopySourceSSECustomerKeyMD5='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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 CopySource: string
    :param CopySource: **[REQUIRED]** The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :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 ServerSideEncryption: string
    :param ServerSideEncryption: The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type CopySourceSSECustomerAlgorithm: string
    :param CopySourceSSECustomerAlgorithm: Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    
    :type CopySourceSSECustomerKey: string
    :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 the encryption key was transmitted without error.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CopyObjectResult': {
                'ETag': 'string',
                'LastModified': datetime(2015, 1, 1)
            },
            'Expiration': 'string',
            'CopySourceVersionId': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CopyObjectResult** *(dict) --* 
          

          - **ETag** *(string) --* 
          

          - **LastModified** *(datetime) --* 
      
        

        - **Expiration** *(string) --* If the object expiration is configured, the response includes this header.
        

        - **CopySourceVersionId** *(string) --* 
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: create_bucket(**kwargs)

    Creates a new bucket.

    **Request Syntax** 
    ::

      response = client.create_bucket(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
          Bucket='string',
          CreateBucketConfiguration={
              'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
          },
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the bucket.

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type CreateBucketConfiguration: dict
    :param CreateBucketConfiguration: 

    
      - **LocationConstraint** *(string) --* Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.

      
    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Location': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Location** *(string) --* 
    

  .. py:method:: create_multipart_upload(**kwargs)

    

    Initiates a multipart upload and returns an upload ID.

     

    **Note:** After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    

    **Request Syntax** 
    ::

      response = client.create_multipart_upload(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-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'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Bucket': 'string',
            'Key': 'string',
            'UploadId': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Bucket** *(string) --* Name of the bucket to which the multipart upload was initiated.
        

        - **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 S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: delete_bucket(**kwargs)

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

    **Request Syntax** 
    ::

      response = client.delete_bucket(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_cors(**kwargs)

    Deletes the cors configuration information set for the bucket.

    **Request Syntax** 
    ::

      response = client.delete_bucket_cors(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_lifecycle(**kwargs)

    Deletes the lifecycle configuration from the bucket.

    **Request Syntax** 
    ::

      response = client.delete_bucket_lifecycle(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_policy(**kwargs)

    Deletes the policy from the bucket.

    **Request Syntax** 
    ::

      response = client.delete_bucket_policy(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_replication(**kwargs)

    

    **Request Syntax** 
    ::

      response = client.delete_bucket_replication(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_tagging(**kwargs)

    Deletes the tags from the bucket.

    **Request Syntax** 
    ::

      response = client.delete_bucket_tagging(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_bucket_website(**kwargs)

    This operation removes the website configuration from the bucket.

    **Request Syntax** 
    ::

      response = client.delete_bucket_website(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: delete_object(**kwargs)

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

    **Request Syntax** 
    ::

      response = client.delete_object(
          Bucket='string',
          Key='string',
          MFA='string',
          VersionId='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

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

    
    :type VersionId: string
    :param VersionId: VersionId used to reference a specific version of the object.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'VersionId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

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

        - **VersionId** *(string) --* Returns the version ID of the delete marker created as a result of the DELETE operation.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: delete_objects(**kwargs)

    This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

    **Request Syntax** 
    ::

      response = client.delete_objects(
          Bucket='string',
          Delete={
              'Objects': [
                  {
                      'Key': 'string',
                      'VersionId': 'string'
                  },
              ],
              'Quiet': True|False
          },
          MFA='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Delete: dict
    :param Delete: **[REQUIRED]** 

    
      - **Objects** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Key** *(string) --* **[REQUIRED]** Key name of the object to delete.

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

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :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) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **VersionId** *(string) --* 
            

            - **DeleteMarker** *(boolean) --* 
            

            - **DeleteMarkerVersionId** *(string) --* 
        
      
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **Errors** *(list) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **VersionId** *(string) --* 
            

            - **Code** *(string) --* 
            

            - **Message** *(string) --* 
        
      
    

  .. py:method:: download_file(Bucket, Key, Filename, ExtraArgs=None, Callback=None, Config=None)

        


  .. py:method:: generate_presigned_post(Bucket, Key, Fields=None, Conditions=None, ExpiresIn=3600)

        
    Builds the url and the form fields used for a presigned s3 post
    
    :type Bucket: string
    :param Bucket: The name of the bucket to presign the post to. Note that
        bucket related conditions should not be included in the
        ``conditions`` parameter.
    
    :type Key: string
    :param Key: Key name, optionally add ${filename} to the end to
        attach the submitted filename. Note that key related condtions and
        fields are filled out for you and should not be included in the
        ``fields`` or ``condtions`` parmater.
    
    :type Fields: dict
    :param Fields: A dictionary of prefilled form fields to build on top
        of. Elements that may be included are acl, Cache-Control,
        Content-Type, Content-Disposition, Content-Encoding, Expires,
        success_action_redirect, redirect, success_action_status,
        and x-amz-meta-.
    
        Note that if a particular element is included in the fields
        dictionary it will not be automatically added to the conditions
        list. You must specify a condition for the element as well.
    
    :type Conditions: list
    :param Conditions: A list of conditions to include in the policy. Each
        element can be either a list or a structure. For example:
    
        [
         {"acl": "public-read"},
         ["content-length-range", 2, 5],
         ["starts-with", "$success_action_redirect", ""]
        ]
    
        Conditions that are included may pertain to acl,
        content-length-range, Cache-Control, Content-Type,
        Content-Disposition, Content-Encoding, Expires,
        success_action_redirect, redirect, success_action_status,
        and/or x-amz-meta-.
    
        Note that if you include a condition, you must specify
        the a valid value in the fields dictionary as well. A value will
        not be added automatically to the fields dictionary based on the
        conditions.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned post
        is valid for.
    
    :rtype: dict
    :returns: A dictionary with two elements: ``url`` and ``fields``.
        Url is the url to post to. Fields is a dictionary filled with
        the form fields and respective values to use when submitting the
        post. For example:
    
        {'url': 'https://mybucket.s3.amazonaws.com
         'fields': {'acl': 'public-read',
                    'key': 'mykey',
                    'signature': 'mysignature',
                    'policy': 'mybase64 encoded policy'}
        }


  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_bucket_acl(**kwargs)

    Gets the access control policy for the bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_acl(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'Grants': [
                {
                    'Grantee': {
                        'DisplayName': 'string',
                        'EmailAddress': 'string',
                        'ID': 'string',
                        'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                        'URI': 'string'
                    },
                    'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ'|'READ_ACP'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Owner** *(dict) --* 
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 
      
        

        - **Grants** *(list) --* A list of grants.
          

          - *(dict) --* 
            

            - **Grantee** *(dict) --* 
              

              - **DisplayName** *(string) --* Screen name of the grantee.
              

              - **EmailAddress** *(string) --* Email address of the grantee.
              

              - **ID** *(string) --* The canonical user ID of the grantee.
              

              - **Type** *(string) --* Type of grantee
              

              - **URI** *(string) --* URI of the grantee group.
          
            

            - **Permission** *(string) --* Specifies the permission given to the grantee.
        
      
    

  .. py:method:: get_bucket_cors(**kwargs)

    Returns the cors configuration for the bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_cors(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CORSRules': [
                {
                    'AllowedHeaders': [
                        'string',
                    ],
                    'AllowedMethods': [
                        'string',
                    ],
                    'AllowedOrigins': [
                        'string',
                    ],
                    'ExposeHeaders': [
                        'string',
                    ],
                    'MaxAgeSeconds': 123
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CORSRules** *(list) --* 
          

          - *(dict) --* 
            

            - **AllowedHeaders** *(list) --* Specifies which headers are allowed in a pre-flight OPTIONS request.
              

              - *(string) --* 
          
            

            - **AllowedMethods** *(list) --* Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.
              

              - *(string) --* 
          
            

            - **AllowedOrigins** *(list) --* 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.
        
      
    

  .. py:method:: get_bucket_lifecycle(**kwargs)

    Returns the lifecycle configuration information set on the bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_lifecycle(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Rules': [
                {
                    'Expiration': {
                        'Date': datetime(2015, 1, 1),
                        'Days': 123
                    },
                    'ID': 'string',
                    'Prefix': 'string',
                    'Status': 'Enabled'|'Disabled',
                    'Transition': {
                        'Date': datetime(2015, 1, 1),
                        'Days': 123,
                        'StorageClass': 'GLACIER'
                    },
                    'NoncurrentVersionTransition': {
                        'NoncurrentDays': 123,
                        'StorageClass': 'GLACIER'
                    },
                    'NoncurrentVersionExpiration': {
                        'NoncurrentDays': 123
                    }
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Rules** *(list) --* 
          

          - *(dict) --* 
            

            - **Expiration** *(dict) --* 
              

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

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

            - **Status** *(string) --* If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
            

            - **Transition** *(dict) --* 
              

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

              - **StorageClass** *(string) --* The class of storage used to store the object.
          
            

            - **NoncurrentVersionTransition** *(dict) --* Container for the transition rule that describes when noncurrent objects transition to the GLACIER 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 GLACIER 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 When an Object Became Noncurrent`_ in the Amazon Simple Storage Service Developer Guide.
              

              - **StorageClass** *(string) --* The class of storage used to store the object.
          
            

            - **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 Simple Storage Service Developer Guide.
          
        
      
    

  .. py:method:: get_bucket_location(**kwargs)

    Returns the region the bucket resides in.

    **Request Syntax** 
    ::

      response = client.get_bucket_location(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **LocationConstraint** *(string) --* 
    

  .. py:method:: get_bucket_logging(**kwargs)

    Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = client.get_bucket_logging(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'LoggingEnabled': {
                'TargetBucket': 'string',
                'TargetGrants': [
                    {
                        'Grantee': {
                            'DisplayName': 'string',
                            'EmailAddress': 'string',
                            'ID': 'string',
                            'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                            'URI': 'string'
                        },
                        'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
                    },
                ],
                'TargetPrefix': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **LoggingEnabled** *(dict) --* 
          

          - **TargetBucket** *(string) --* 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) --* 
            

            - *(dict) --* 
              

              - **Grantee** *(dict) --* 
                

                - **DisplayName** *(string) --* Screen name of the grantee.
                

                - **EmailAddress** *(string) --* Email address of the grantee.
                

                - **ID** *(string) --* The canonical user ID of the grantee.
                

                - **Type** *(string) --* Type of grantee
                

                - **URI** *(string) --* URI of the grantee group.
            
              

              - **Permission** *(string) --* Logging permissions assigned to the Grantee for the bucket.
          
        
          

          - **TargetPrefix** *(string) --* This element lets you specify a prefix for the keys that the log files will be stored under.
      
    

  .. py:method:: get_bucket_notification(**kwargs)

    Deprecated, see the GetBucketNotificationConfiguration operation.

    **Request Syntax** 
    ::

      response = client.get_bucket_notification(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** Name of the buket to get the notification configuration for.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TopicConfiguration': {
                'Id': 'string',
                'Events': [
                    's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                ],
                'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                'Topic': 'string'
            },
            'QueueConfiguration': {
                'Id': 'string',
                'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                'Events': [
                    's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                ],
                'Queue': 'string'
            },
            'CloudFunctionConfiguration': {
                'Id': 'string',
                'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                'Events': [
                    's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                ],
                'CloudFunction': 'string',
                'InvocationRole': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **TopicConfiguration** *(dict) --* 
          

          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
          

          - **Events** *(list) --* 
            

            - *(string) --* Bucket event for which to send notifications.
        
          

          - **Event** *(string) --* Bucket event for which to send notifications.
          

          - **Topic** *(string) --* Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
      
        

        - **QueueConfiguration** *(dict) --* 
          

          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
          

          - **Event** *(string) --* Bucket event for which to send notifications.
          

          - **Events** *(list) --* 
            

            - *(string) --* Bucket event for which to send notifications.
        
          

          - **Queue** *(string) --* 
      
        

        - **CloudFunctionConfiguration** *(dict) --* 
          

          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
          

          - **Event** *(string) --* Bucket event for which to send notifications.
          

          - **Events** *(list) --* 
            

            - *(string) --* Bucket event for which to send notifications.
        
          

          - **CloudFunction** *(string) --* 
          

          - **InvocationRole** *(string) --* 
      
    

  .. py:method:: get_bucket_notification_configuration(**kwargs)

    Returns the notification configuration of a bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_notification_configuration(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** Name of the buket to get the notification configuration for.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TopicConfigurations': [
                {
                    'Id': 'string',
                    'TopicArn': 'string',
                    'Events': [
                        's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                    ]
                },
            ],
            'QueueConfigurations': [
                {
                    'Id': 'string',
                    'QueueArn': 'string',
                    'Events': [
                        's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                    ]
                },
            ],
            'LambdaFunctionConfigurations': [
                {
                    'Id': 'string',
                    'LambdaFunctionArn': 'string',
                    'Events': [
                        's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.
        

        - **TopicConfigurations** *(list) --* 
          

          - *(dict) --* Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.
            

            - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
            

            - **TopicArn** *(string) --* Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.
            

            - **Events** *(list) --* 
              

              - *(string) --* Bucket event for which to send notifications.
          
        
      
        

        - **QueueConfigurations** *(list) --* 
          

          - *(dict) --* Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.
            

            - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
            

            - **QueueArn** *(string) --* Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.
            

            - **Events** *(list) --* 
              

              - *(string) --* Bucket event for which to send notifications.
          
        
      
        

        - **LambdaFunctionConfigurations** *(list) --* 
          

          - *(dict) --* Container for specifying the AWS Lambda notification configuration.
            

            - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
            

            - **LambdaFunctionArn** *(string) --* Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
            

            - **Events** *(list) --* 
              

              - *(string) --* Bucket event for which to send notifications.
          
        
      
    

  .. py:method:: get_bucket_policy(**kwargs)

    Returns the policy of a specified bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_policy(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Policy': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Policy** *(string) --* The bucket policy as a JSON document.
    

  .. py:method:: get_bucket_replication(**kwargs)

    

    **Request Syntax** 
    ::

      response = client.get_bucket_replication(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReplicationConfiguration': {
                'Role': 'string',
                'Rules': [
                    {
                        'ID': 'string',
                        'Prefix': 'string',
                        'Status': 'Enabled'|'Disabled',
                        'Destination': {
                            'Bucket': 'string'
                        }
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **ReplicationConfiguration** *(dict) --* Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.
          

          - **Role** *(string) --* Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.
          

          - **Rules** *(list) --* Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.
            

            - *(dict) --* 
              

              - **ID** *(string) --* Unique identifier for the rule. The value cannot be longer than 255 characters.
              

              - **Prefix** *(string) --* Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.
              

              - **Status** *(string) --* The rule is ignored if status is not Enabled.
              

              - **Destination** *(dict) --* 
                

                - **Bucket** *(string) --* Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.
            
          
        
      
    

  .. py:method:: get_bucket_request_payment(**kwargs)

    Returns the request payment configuration of a bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_request_payment(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Payer': 'Requester'|'BucketOwner'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Payer** *(string) --* Specifies who pays for the download and request fees.
    

  .. py:method:: get_bucket_tagging(**kwargs)

    Returns the tag set associated with the bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_tagging(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **TagSet** *(list) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* Name of the tag.
            

            - **Value** *(string) --* Value of the tag.
        
      
    

  .. py:method:: get_bucket_versioning(**kwargs)

    Returns the versioning state of a bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_versioning(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Status': 'Enabled'|'Suspended',
            'MFADelete': 'Enabled'|'Disabled'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Status** *(string) --* The versioning state of the bucket.
        

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

  .. py:method:: get_bucket_website(**kwargs)

    Returns the website configuration for a bucket.

    **Request Syntax** 
    ::

      response = client.get_bucket_website(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RedirectAllRequestsTo': {
                'HostName': 'string',
                'Protocol': 'http'|'https'
            },
            'IndexDocument': {
                'Suffix': 'string'
            },
            'ErrorDocument': {
                'Key': 'string'
            },
            'RoutingRules': [
                {
                    'Condition': {
                        'HttpErrorCodeReturnedEquals': 'string',
                        'KeyPrefixEquals': 'string'
                    },
                    'Redirect': {
                        'HostName': 'string',
                        'HttpRedirectCode': 'string',
                        'Protocol': 'http'|'https',
                        'ReplaceKeyPrefixWith': 'string',
                        'ReplaceKeyWith': 'string'
                    }
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RedirectAllRequestsTo** *(dict) --* 
          

          - **HostName** *(string) --* Name of the host where requests will be redirected.
          

          - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
      
        

        - **IndexDocument** *(dict) --* 
          

          - **Suffix** *(string) --* A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
      
        

        - **ErrorDocument** *(dict) --* 
          

          - **Key** *(string) --* The object key name to use when a 4XX class error occurs.
      
        

        - **RoutingRules** *(list) --* 
          

          - *(dict) --* 
            

            - **Condition** *(dict) --* A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
              

              - **HttpErrorCodeReturnedEquals** *(string) --* The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
              

              - **KeyPrefixEquals** *(string) --* The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
          
            

            - **Redirect** *(dict) --* Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.
              

              - **HostName** *(string) --* The host name to use in the redirect request.
              

              - **HttpRedirectCode** *(string) --* The HTTP redirect code to use on the response. Not required if one of the siblings is present.
              

              - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
              

              - **ReplaceKeyPrefixWith** *(string) --* The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
              

              - **ReplaceKeyWith** *(string) --* The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.
          
        
      
    

  .. py:method:: get_object(**kwargs)

    Retrieves objects from Amazon S3.

    **Request Syntax** 
    ::

      response = 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='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Body': b'bytes',
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            'ETag': '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Body** *(bytes) --* 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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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.
        

        - **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 S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: get_object_acl(**kwargs)

    Returns the access control list (ACL) of an object.

    **Request Syntax** 
    ::

      response = client.get_object_acl(
          Bucket='string',
          Key='string',
          VersionId='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type VersionId: string
    :param VersionId: VersionId used to reference a specific version of the object.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'Grants': [
                {
                    'Grantee': {
                        'DisplayName': 'string',
                        'EmailAddress': 'string',
                        'ID': 'string',
                        'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                        'URI': 'string'
                    },
                    'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ'|'READ_ACP'
                },
            ],
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Owner** *(dict) --* 
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 
      
        

        - **Grants** *(list) --* A list of grants.
          

          - *(dict) --* 
            

            - **Grantee** *(dict) --* 
              

              - **DisplayName** *(string) --* Screen name of the grantee.
              

              - **EmailAddress** *(string) --* Email address of the grantee.
              

              - **ID** *(string) --* The canonical user ID of the grantee.
              

              - **Type** *(string) --* Type of grantee
              

              - **URI** *(string) --* URI of the grantee group.
          
            

            - **Permission** *(string) --* Specifies the permission given to the grantee.
        
      
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: get_object_torrent(**kwargs)

    Return torrent files from a bucket.

    **Request Syntax** 
    ::

      response = client.get_object_torrent(
          Bucket='string',
          Key='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Body': b'bytes',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Body** *(bytes) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_waiter(waiter_name)

        


  .. py:method:: head_bucket(**kwargs)

    This operation is useful to determine if a bucket exists and you have permission to access it.

    **Request Syntax** 
    ::

      response = client.head_bucket(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

  .. py:method:: head_object(**kwargs)

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

    **Request Syntax** 
    ::

      response = 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='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: list_buckets()

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

    **Request Syntax** 

    ::

      response = client.list_buckets()
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Buckets': [
                {
                    'Name': 'string',
                    'CreationDate': datetime(2015, 1, 1)
                },
            ],
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Buckets** *(list) --* 
          

          - *(dict) --* 
            

            - **Name** *(string) --* The name of the bucket.
            

            - **CreationDate** *(datetime) --* Date the bucket was created.
        
      
        

        - **Owner** *(dict) --* 
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 
      
    

  .. py:method:: list_multipart_uploads(**kwargs)

    This operation lists in-progress multipart uploads.

    **Request Syntax** 
    ::

      response = client.list_multipart_uploads(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          KeyMarker='string',
          MaxUploads=123,
          Prefix='string',
          UploadIdMarker='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Delimiter: string
    :param Delimiter: 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 KeyMarker: string
    :param KeyMarker: Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

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

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

    
    
    :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'|'LT',
                    'Owner': {
                        'DisplayName': 'string',
                        'ID': 'string'
                    },
                    'Initiator': {
                        'ID': 'string',
                        'DisplayName': 'string'
                    }
                },
            ],
            'CommonPrefixes': [
                {
                    'Prefix': 'string'
                },
            ],
            'EncodingType': 'url'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Bucket** *(string) --* Name of the bucket to which the multipart upload was initiated.
        

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

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

          - *(dict) --* 
            

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

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
            

            - **Initiator** *(dict) --* Identifies who initiated the multipart upload.
              

              - **ID** *(string) --* If the principal is an AWS 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.
          
        
      
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
    

  .. py:method:: list_object_versions(**kwargs)

    Returns metadata about all of the versions of objects in a bucket.

    **Request Syntax** 
    ::

      response = client.list_object_versions(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          KeyMarker='string',
          MaxKeys=123,
          Prefix='string',
          VersionIdMarker='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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 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. 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 VersionIdMarker: string
    :param VersionIdMarker: Specifies the object version you want to start listing from.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IsTruncated': True|False,
            'KeyMarker': 'string',
            'VersionIdMarker': 'string',
            'NextKeyMarker': 'string',
            'NextVersionIdMarker': 'string',
            'Versions': [
                {
                    'ETag': 'string',
                    '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 or not 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) --* 
        

        - **NextKeyMarker** *(string) --* Use this value for the key marker request parameter in a subsequent request.
        

        - **NextVersionIdMarker** *(string) --* Use this value for the next version id marker parameter in a subsequent request.
        

        - **Versions** *(list) --* 
          

          - *(dict) --* 
            

            - **ETag** *(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) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
        
      
        

        - **DeleteMarkers** *(list) --* 
          

          - *(dict) --* 
            

            - **Owner** *(dict) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
            

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

        - **Prefix** *(string) --* 
        

        - **Delimiter** *(string) --* 
        

        - **MaxKeys** *(integer) --* 
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
    

  .. py:method:: list_objects(**kwargs)

    Returns some or all (up to 1000) 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.

    **Request Syntax** 
    ::

      response = client.list_objects(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          Marker='string',
          MaxKeys=123,
          Prefix='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IsTruncated': True|False,
            'Marker': 'string',
            'NextMarker': 'string',
            'Contents': [
                {
                    'Key': 'string',
                    'LastModified': datetime(2015, 1, 1),
                    'ETag': 'string',
                    'Size': 123,
                    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACIER',
                    '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 or not Amazon S3 returned all of the results that satisfied the search criteria.
        

        - **Marker** *(string) --* 
        

        - **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 NextMaker 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) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **LastModified** *(datetime) --* 
            

            - **ETag** *(string) --* 
            

            - **Size** *(integer) --* 
            

            - **StorageClass** *(string) --* The class of storage used to store the object.
            

            - **Owner** *(dict) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
        
      
        

        - **Name** *(string) --* 
        

        - **Prefix** *(string) --* 
        

        - **Delimiter** *(string) --* 
        

        - **MaxKeys** *(integer) --* 
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
    

  .. py:method:: list_parts(**kwargs)

    Lists the parts that have been uploaded for a specific multipart upload.

    **Request Syntax** 
    ::

      response = client.list_parts(
          Bucket='string',
          Key='string',
          MaxParts=123,
          PartNumberMarker=123,
          UploadId='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :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 she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            '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
                },
            ],
            'Initiator': {
                'ID': 'string',
                'DisplayName': 'string'
            },
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Bucket** *(string) --* Name of the bucket to which the multipart upload was initiated.
        

        - **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) --* Part number after which listing begins.
        

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

        - **Parts** *(list) --* 
          

          - *(dict) --* 
            

            - **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 of the uploaded part data.
        
      
        

        - **Initiator** *(dict) --* Identifies who initiated the multipart upload.
          

          - **ID** *(string) --* If the principal is an AWS 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) --* 
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 
      
        

        - **StorageClass** *(string) --* The class of storage used to store the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: put_bucket_acl(**kwargs)

    Sets the permissions on a bucket using access control lists (ACL).

    **Request Syntax** 
    ::

      response = 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',
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the bucket.

    
    :type AccessControlPolicy: dict
    :param AccessControlPolicy: 

    
      - **Grants** *(list) --* A list of grants.

      
        - *(dict) --* 

        
          - **Grantee** *(dict) --* 

          
            - **DisplayName** *(string) --* Screen name of the grantee.

            
            - **EmailAddress** *(string) --* Email address of the grantee.

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

      
        - **DisplayName** *(string) --* 

        
        - **ID** *(string) --* 

        
      
    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    
    :returns: None

  .. py:method:: put_bucket_cors(**kwargs)

    Sets the cors configuration for a bucket.

    **Request Syntax** 
    ::

      response = client.put_bucket_cors(
          Bucket='string',
          CORSConfiguration={
              'CORSRules': [
                  {
                      'AllowedHeaders': [
                          'string',
                      ],
                      'AllowedMethods': [
                          'string',
                      ],
                      'AllowedOrigins': [
                          'string',
                      ],
                      'ExposeHeaders': [
                          'string',
                      ],
                      'MaxAgeSeconds': 123
                  },
              ]
          },
          
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type CORSConfiguration: dict
    :param CORSConfiguration: 

    
      - **CORSRules** *(list) --* 

      
        - *(dict) --* 

        
          - **AllowedHeaders** *(list) --* Specifies which headers are allowed in a pre-flight OPTIONS request.

          
            - *(string) --* 

            
        
          - **AllowedMethods** *(list) --* Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.

          
            - *(string) --* 

            
        
          - **AllowedOrigins** *(list) --* 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.

          
        
    
    
    
    :returns: None

  .. py:method:: put_bucket_lifecycle(**kwargs)

    Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

    **Request Syntax** 
    ::

      response = client.put_bucket_lifecycle(
          Bucket='string',
          LifecycleConfiguration={
              'Rules': [
                  {
                      'Expiration': {
                          'Date': datetime(2015, 1, 1),
                          'Days': 123
                      },
                      'ID': 'string',
                      'Prefix': 'string',
                      'Status': 'Enabled'|'Disabled',
                      'Transition': {
                          'Date': datetime(2015, 1, 1),
                          'Days': 123,
                          'StorageClass': 'GLACIER'
                      },
                      'NoncurrentVersionTransition': {
                          'NoncurrentDays': 123,
                          'StorageClass': 'GLACIER'
                      },
                      'NoncurrentVersionExpiration': {
                          'NoncurrentDays': 123
                      }
                  },
              ]
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type LifecycleConfiguration: dict
    :param LifecycleConfiguration: 

    
      - **Rules** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Expiration** *(dict) --* 

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

            
          
          - **ID** *(string) --* Unique identifier for the rule. The value cannot be longer than 255 characters.

          
          - **Prefix** *(string) --* **[REQUIRED]** Prefix identifying one or more objects 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.

          
          - **Transition** *(dict) --* 

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

            
            - **StorageClass** *(string) --* The class of storage used to store the object.

            
          
          - **NoncurrentVersionTransition** *(dict) --* Container for the transition rule that describes when noncurrent objects transition to the GLACIER 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 GLACIER 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 When an Object Became Noncurrent`_ in the Amazon Simple Storage Service Developer Guide.

            
            - **StorageClass** *(string) --* The class of storage used to store the object.

            
          
          - **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 Simple Storage Service Developer Guide.

            
          
        
    
    
    
    :returns: None

  .. py:method:: put_bucket_logging(**kwargs)

    Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = 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'
              }
          },
          
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type BucketLoggingStatus: dict
    :param BucketLoggingStatus: **[REQUIRED]** 

    
      - **LoggingEnabled** *(dict) --* 

      
        - **TargetBucket** *(string) --* 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) --* 

        
          - *(dict) --* 

          
            - **Grantee** *(dict) --* 

            
              - **DisplayName** *(string) --* Screen name of the grantee.

              
              - **EmailAddress** *(string) --* Email address of the grantee.

              
              - **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) --* This element lets you specify a prefix for the keys that the log files will be stored under.

        
      
    
    
    :returns: None

  .. py:method:: put_bucket_notification(**kwargs)

    Deprecated, see the PutBucketNotificationConfiguraiton operation.

    **Request Syntax** 
    ::

      response = client.put_bucket_notification(
          Bucket='string',
          NotificationConfiguration={
              'TopicConfiguration': {
                  'Id': 'string',
                  'Events': [
                      's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  ],
                  'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  'Topic': 'string'
              },
              'QueueConfiguration': {
                  'Id': 'string',
                  'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  'Events': [
                      's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  ],
                  'Queue': 'string'
              },
              'CloudFunctionConfiguration': {
                  'Id': 'string',
                  'Event': 's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  'Events': [
                      's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                  ],
                  'CloudFunction': 'string',
                  'InvocationRole': 'string'
              }
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type NotificationConfiguration: dict
    :param NotificationConfiguration: **[REQUIRED]** 

    
      - **TopicConfiguration** *(dict) --* 

      
        - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        
        - **Events** *(list) --* 

        
          - *(string) --* Bucket event for which to send notifications.

          
      
        - **Event** *(string) --* Bucket event for which to send notifications.

        
        - **Topic** *(string) --* Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

        
      
      - **QueueConfiguration** *(dict) --* 

      
        - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        
        - **Event** *(string) --* Bucket event for which to send notifications.

        
        - **Events** *(list) --* 

        
          - *(string) --* Bucket event for which to send notifications.

          
      
        - **Queue** *(string) --* 

        
      
      - **CloudFunctionConfiguration** *(dict) --* 

      
        - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        
        - **Event** *(string) --* Bucket event for which to send notifications.

        
        - **Events** *(list) --* 

        
          - *(string) --* Bucket event for which to send notifications.

          
      
        - **CloudFunction** *(string) --* 

        
        - **InvocationRole** *(string) --* 

        
      
    
    
    :returns: None

  .. py:method:: put_bucket_notification_configuration(**kwargs)

    Enables notifications of specified events for a bucket.

    **Request Syntax** 
    ::

      response = client.put_bucket_notification_configuration(
          Bucket='string',
          NotificationConfiguration={
              'TopicConfigurations': [
                  {
                      'Id': 'string',
                      'TopicArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ],
              'QueueConfigurations': [
                  {
                      'Id': 'string',
                      'QueueArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ],
              'LambdaFunctionConfigurations': [
                  {
                      'Id': 'string',
                      'LambdaFunctionArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ]
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type NotificationConfiguration: dict
    :param NotificationConfiguration: **[REQUIRED]** Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.

    
      - **TopicConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **TopicArn** *(string) --* **[REQUIRED]** Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
      - **QueueConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **QueueArn** *(string) --* **[REQUIRED]** Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
      - **LambdaFunctionConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying the AWS Lambda notification configuration.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **LambdaFunctionArn** *(string) --* **[REQUIRED]** Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
    
    
    :returns: None

  .. py:method:: put_bucket_policy(**kwargs)

    Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

    **Request Syntax** 
    ::

      response = client.put_bucket_policy(
          Bucket='string',
          Policy='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Policy: string
    :param Policy: **[REQUIRED]** The bucket policy as a JSON document.

    
    
    :returns: None

  .. py:method:: put_bucket_replication(**kwargs)

    Creates a new replication configuration (or replaces an existing one, if present).

    **Request Syntax** 
    ::

      response = client.put_bucket_replication(
          Bucket='string',
          ReplicationConfiguration={
              'Role': 'string',
              'Rules': [
                  {
                      'ID': 'string',
                      'Prefix': 'string',
                      'Status': 'Enabled'|'Disabled',
                      'Destination': {
                          'Bucket': 'string'
                      }
                  },
              ]
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type ReplicationConfiguration: dict
    :param ReplicationConfiguration: **[REQUIRED]** Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.

    
      - **Role** *(string) --* **[REQUIRED]** Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.

      
      - **Rules** *(list) --* **[REQUIRED]** Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.

      
        - *(dict) --* 

        
          - **ID** *(string) --* Unique identifier for the rule. The value cannot be longer than 255 characters.

          
          - **Prefix** *(string) --* **[REQUIRED]** Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.

          
          - **Status** *(string) --* **[REQUIRED]** The rule is ignored if status is not Enabled.

          
          - **Destination** *(dict) --* **[REQUIRED]** 

          
            - **Bucket** *(string) --* **[REQUIRED]** Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.

            
          
        
    
    
    
    :returns: None

  .. py:method:: put_bucket_request_payment(**kwargs)

    Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

    **Request Syntax** 
    ::

      response = client.put_bucket_request_payment(
          Bucket='string',
          RequestPaymentConfiguration={
              'Payer': 'Requester'|'BucketOwner'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type RequestPaymentConfiguration: dict
    :param RequestPaymentConfiguration: **[REQUIRED]** 

    
      - **Payer** *(string) --* **[REQUIRED]** Specifies who pays for the download and request fees.

      
    
    
    :returns: None

  .. py:method:: put_bucket_tagging(**kwargs)

    Sets the tags for a bucket.

    **Request Syntax** 
    ::

      response = client.put_bucket_tagging(
          Bucket='string',
          Tagging={
              'TagSet': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Tagging: dict
    :param Tagging: **[REQUIRED]** 

    
      - **TagSet** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Key** *(string) --* **[REQUIRED]** Name of the tag.

          
          - **Value** *(string) --* **[REQUIRED]** Value of the tag.

          
        
    
    
    
    :returns: None

  .. py:method:: put_bucket_versioning(**kwargs)

    Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = client.put_bucket_versioning(
          Bucket='string',
          MFA='string',
          VersioningConfiguration={
              'MFADelete': 'Enabled'|'Disabled',
              'Status': 'Enabled'|'Suspended'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type VersioningConfiguration: dict
    :param VersioningConfiguration: **[REQUIRED]** 

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

      
      - **Status** *(string) --* The versioning state of the bucket.

      
    
    
    :returns: None

  .. py:method:: put_bucket_website(**kwargs)

    Set the website configuration for a bucket.

    **Request Syntax** 
    ::

      response = client.put_bucket_website(
          Bucket='string',
          WebsiteConfiguration={
              'ErrorDocument': {
                  'Key': 'string'
              },
              'IndexDocument': {
                  'Suffix': 'string'
              },
              'RedirectAllRequestsTo': {
                  'HostName': 'string',
                  'Protocol': 'http'|'https'
              },
              'RoutingRules': [
                  {
                      'Condition': {
                          'HttpErrorCodeReturnedEquals': 'string',
                          'KeyPrefixEquals': 'string'
                      },
                      'Redirect': {
                          'HostName': 'string',
                          'HttpRedirectCode': 'string',
                          'Protocol': 'http'|'https',
                          'ReplaceKeyPrefixWith': 'string',
                          'ReplaceKeyWith': 'string'
                      }
                  },
              ]
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type WebsiteConfiguration: dict
    :param WebsiteConfiguration: **[REQUIRED]** 

    
      - **ErrorDocument** *(dict) --* 

      
        - **Key** *(string) --* **[REQUIRED]** The object key name to use when a 4XX class error occurs.

        
      
      - **IndexDocument** *(dict) --* 

      
        - **Suffix** *(string) --* **[REQUIRED]** A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

        
      
      - **RedirectAllRequestsTo** *(dict) --* 

      
        - **HostName** *(string) --* **[REQUIRED]** Name of the host where requests will be redirected.

        
        - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

        
      
      - **RoutingRules** *(list) --* 

      
        - *(dict) --* 

        
          - **Condition** *(dict) --* A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

          
            - **HttpErrorCodeReturnedEquals** *(string) --* The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

            
            - **KeyPrefixEquals** *(string) --* The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

            
          
          - **Redirect** *(dict) --* **[REQUIRED]** Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.

          
            - **HostName** *(string) --* The host name to use in the redirect request.

            
            - **HttpRedirectCode** *(string) --* The HTTP redirect code to use on the response. Not required if one of the siblings is present.

            
            - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

            
            - **ReplaceKeyPrefixWith** *(string) --* The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

            
            - **ReplaceKeyWith** *(string) --* The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

            
          
        
    
    
    
    :returns: None

  .. py:method:: put_object(**kwargs)

    Adds an object to a bucket.

    **Request Syntax** 
    ::

      response = client.put_object(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          Body=b'bytes',
          Bucket='string',
          CacheControl='string',
          ContentDisposition='string',
          ContentEncoding='string',
          ContentLanguage='string',
          ContentLength=123,
          ContentMD5='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'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type Body: bytes
    :param Body: Object data.

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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 ContentLength: integer
    :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    
    :type ContentMD5: string
    :param ContentMD5: 

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Expiration': 'string',
            'ETag': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'VersionId': 'string',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **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 for the uploaded object.
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **VersionId** *(string) --* Version of the object.
        

        - **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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: put_object_acl(**kwargs)

    uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

    **Request Syntax** 
    ::

      response = client.put_object_acl(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          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',
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string',
          Key='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type AccessControlPolicy: dict
    :param AccessControlPolicy: 

    
      - **Grants** *(list) --* A list of grants.

      
        - *(dict) --* 

        
          - **Grantee** *(dict) --* 

          
            - **DisplayName** *(string) --* Screen name of the grantee.

            
            - **EmailAddress** *(string) --* Email address of the grantee.

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

      
        - **DisplayName** *(string) --* 

        
        - **ID** *(string) --* 

        
      
    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: restore_object(**kwargs)

    Restores an archived copy of an object back into Amazon S3

    **Request Syntax** 
    ::

      response = client.restore_object(
          Bucket='string',
          Key='string',
          VersionId='string',
          RestoreRequest={
              'Days': 123
          },
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type VersionId: string
    :param VersionId: 

    
    :type RestoreRequest: dict
    :param RestoreRequest: 

    
      - **Days** *(integer) --* **[REQUIRED]** Lifetime of the active copy in days

      
    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: upload_file(Filename, Bucket, Key, ExtraArgs=None, Callback=None, Config=None)

        


  .. py:method:: upload_part(**kwargs)

    

    Uploads a part in a multipart upload.

     

    **Note:** After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    

    **Request Syntax** 
    ::

      response = client.upload_part(
          Body=b'bytes',
          Bucket='string',
          ContentLength=123,
          ContentMD5='string',
          Key='string',
          PartNumber=123,
          UploadId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :type Body: bytes
    :param Body: 

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type ContentLength: integer
    :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    
    :type ContentMD5: string
    :param ContentMD5: 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type PartNumber: integer
    :param PartNumber: **[REQUIRED]** Part number of part being uploaded. This is a positive integer between 1 and 10,000.

    
    :type UploadId: string
    :param UploadId: **[REQUIRED]** Upload ID identifying the multipart upload whose part is being uploaded.

    
    :type SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    
    :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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'ETag': 'string',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **ETag** *(string) --* Entity tag for the uploaded object.
        

        - **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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: upload_part_copy(**kwargs)

    Uploads a part by copying data from an existing object as data source.

    **Request Syntax** 
    ::

      response = client.upload_part_copy(
          Bucket='string',
          CopySource='string',
          CopySourceIfMatch='string',
          CopySourceIfModifiedSince=datetime(2015, 1, 1),
          CopySourceIfNoneMatch='string',
          CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
          CopySourceRange='string',
          Key='string',
          PartNumber=123,
          UploadId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          CopySourceSSECustomerAlgorithm='string',
          CopySourceSSECustomerKey='string',
          CopySourceSSECustomerKeyMD5='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type CopySource: string
    :param CopySource: **[REQUIRED]** The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    
    :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 CopySourceRange: string
    :param CopySourceRange: The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type PartNumber: integer
    :param PartNumber: **[REQUIRED]** Part number of part being copied. This is a positive integer between 1 and 10,000.

    
    :type UploadId: string
    :param UploadId: **[REQUIRED]** Upload ID identifying the multipart upload whose part is being copied.

    
    :type SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    
    :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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type CopySourceSSECustomerAlgorithm: string
    :param CopySourceSSECustomerAlgorithm: Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    
    :type CopySourceSSECustomerKey: string
    :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 the encryption key was transmitted without error.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CopySourceVersionId': 'string',
            'CopyPartResult': {
                'ETag': 'string',
                'LastModified': datetime(2015, 1, 1)
            },
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CopySourceVersionId** *(string) --* The version of the source object that was copied, if you have enabled versioning on the source bucket.
        

        - **CopyPartResult** *(dict) --* 
          

          - **ETag** *(string) --* Entity tag of the object.
          

          - **LastModified** *(datetime) --* Date and time at which the object was uploaded.
      
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

==========
Paginators
==========


The available paginators are:

* :py:class:`S3.Paginator.list_multipart_uploads`


* :py:class:`S3.Paginator.list_object_versions`


* :py:class:`S3.Paginator.list_objects`


* :py:class:`S3.Paginator.list_parts`



.. py:class:: S3.Paginator.list_multipart_uploads

  ::

    
    paginator = client.get_paginator('list_multipart_uploads')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`S3.Client.list_multipart_uploads`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          Prefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Delimiter: string
    :param Delimiter: 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 Prefix: string
    :param Prefix: Lists in-progress uploads only for those keys that begin with the specified prefix.

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Bucket': 'string',
            'KeyMarker': 'string',
            'UploadIdMarker': 'string',
            'Prefix': 'string',
            'Delimiter': 'string',
            'MaxUploads': 123,
            'IsTruncated': True|False,
            'Uploads': [
                {
                    'UploadId': 'string',
                    'Key': 'string',
                    'Initiated': datetime(2015, 1, 1),
                    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
                    'Owner': {
                        'DisplayName': 'string',
                        'ID': 'string'
                    },
                    'Initiator': {
                        'ID': 'string',
                        'DisplayName': 'string'
                    }
                },
            ],
            'CommonPrefixes': [
                {
                    'Prefix': 'string'
                },
            ],
            'EncodingType': 'url',
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Bucket** *(string) --* Name of the bucket to which the multipart upload was initiated.
        

        - **KeyMarker** *(string) --* The key at or after which the listing began.
        

        - **UploadIdMarker** *(string) --* Upload ID after which listing began.
        

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

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

          - *(dict) --* 
            

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

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
            

            - **Initiator** *(dict) --* Identifies who initiated the multipart upload.
              

              - **ID** *(string) --* If the principal is an AWS 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.
          
        
      
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: S3.Paginator.list_object_versions

  ::

    
    paginator = client.get_paginator('list_object_versions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`S3.Client.list_object_versions`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          Prefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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 Prefix: string
    :param Prefix: Limits the response to keys that begin with the specified prefix.

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IsTruncated': True|False,
            'KeyMarker': 'string',
            'VersionIdMarker': 'string',
            'Versions': [
                {
                    'ETag': 'string',
                    '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',
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **IsTruncated** *(boolean) --* A flag that indicates whether or not 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) --* 
        

        - **Versions** *(list) --* 
          

          - *(dict) --* 
            

            - **ETag** *(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) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
        
      
        

        - **DeleteMarkers** *(list) --* 
          

          - *(dict) --* 
            

            - **Owner** *(dict) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
            

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

        - **Prefix** *(string) --* 
        

        - **Delimiter** *(string) --* 
        

        - **MaxKeys** *(integer) --* 
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: S3.Paginator.list_objects

  ::

    
    paginator = client.get_paginator('list_objects')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`S3.Client.list_objects`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          Bucket='string',
          Delimiter='string',
          EncodingType='url',
          Prefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :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 Prefix: string
    :param Prefix: Limits the response to keys that begin with the specified prefix.

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IsTruncated': True|False,
            'Marker': 'string',
            'NextMarker': 'string',
            'Contents': [
                {
                    'Key': 'string',
                    'LastModified': datetime(2015, 1, 1),
                    'ETag': 'string',
                    'Size': 123,
                    'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACIER',
                    'Owner': {
                        'DisplayName': 'string',
                        'ID': 'string'
                    }
                },
            ],
            'Name': 'string',
            'Prefix': 'string',
            'Delimiter': 'string',
            'MaxKeys': 123,
            'CommonPrefixes': [
                {
                    'Prefix': 'string'
                },
            ],
            'EncodingType': 'url',
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **IsTruncated** *(boolean) --* A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
        

        - **Marker** *(string) --* 
        

        - **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 NextMaker 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) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **LastModified** *(datetime) --* 
            

            - **ETag** *(string) --* 
            

            - **Size** *(integer) --* 
            

            - **StorageClass** *(string) --* The class of storage used to store the object.
            

            - **Owner** *(dict) --* 
              

              - **DisplayName** *(string) --* 
              

              - **ID** *(string) --* 
          
        
      
        

        - **Name** *(string) --* 
        

        - **Prefix** *(string) --* 
        

        - **Delimiter** *(string) --* 
        

        - **MaxKeys** *(integer) --* 
        

        - **CommonPrefixes** *(list) --* 
          

          - *(dict) --* 
            

            - **Prefix** *(string) --* 
        
      
        

        - **EncodingType** *(string) --* Encoding type used by Amazon S3 to encode object keys in the response.
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: S3.Paginator.list_parts

  ::

    
    paginator = client.get_paginator('list_parts')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`S3.Client.list_parts`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          Bucket='string',
          Key='string',
          UploadId='string',
          RequestPayer='requester',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :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 she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Bucket': 'string',
            'Key': 'string',
            'UploadId': 'string',
            'PartNumberMarker': 123,
            'MaxParts': 123,
            'IsTruncated': True|False,
            'Parts': [
                {
                    'PartNumber': 123,
                    'LastModified': datetime(2015, 1, 1),
                    'ETag': 'string',
                    'Size': 123
                },
            ],
            'Initiator': {
                'ID': 'string',
                'DisplayName': 'string'
            },
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Bucket** *(string) --* Name of the bucket to which the multipart upload was initiated.
        

        - **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) --* Part number after which listing begins.
        

        - **MaxParts** *(integer) --* Maximum number of parts that were allowed in the response.
        

        - **IsTruncated** *(boolean) --* Indicates whether the returned list of parts is truncated.
        

        - **Parts** *(list) --* 
          

          - *(dict) --* 
            

            - **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 of the uploaded part data.
        
      
        

        - **Initiator** *(dict) --* Identifies who initiated the multipart upload.
          

          - **ID** *(string) --* If the principal is an AWS 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) --* 
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 
      
        

        - **StorageClass** *(string) --* The class of storage used to store the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

=======
Waiters
=======


The available waiters are:

* :py:class:`S3.Waiter.bucket_exists`


* :py:class:`S3.Waiter.bucket_not_exists`


* :py:class:`S3.Waiter.object_exists`


* :py:class:`S3.Waiter.object_not_exists`



.. py:class:: S3.Waiter.bucket_exists

  ::

    
    waiter = client.get_waiter('bucket_exists')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`S3.Client.head_bucket` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

.. py:class:: S3.Waiter.bucket_not_exists

  ::

    
    waiter = client.get_waiter('bucket_not_exists')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`S3.Client.head_bucket` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          Bucket='string'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    
    :returns: None

.. py:class:: S3.Waiter.object_exists

  ::

    
    waiter = client.get_waiter('object_exists')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          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='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :returns: None

.. py:class:: S3.Waiter.object_not_exists

  ::

    
    waiter = client.get_waiter('object_not_exists')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          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='string',
          RequestPayer='requester'
      )
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

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

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Key: string
    :param Key: **[REQUIRED]** 

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :returns: None

================
Service Resource
================



.. py:class:: S3.ServiceResource()

  A resource representing Amazon Simple Storage Service (S3)::

    
    import boto3
    
    s3 = boto3.resource('s3')

  
  These are the resource's available actions:
  
  *   :py:meth:`create_bucket()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  *   :py:meth:`BucketAcl()`

  
  *   :py:meth:`BucketCors()`

  
  *   :py:meth:`BucketLifecycle()`

  
  *   :py:meth:`BucketLogging()`

  
  *   :py:meth:`BucketNotification()`

  
  *   :py:meth:`BucketPolicy()`

  
  *   :py:meth:`BucketRequestPayment()`

  
  *   :py:meth:`BucketTagging()`

  
  *   :py:meth:`BucketVersioning()`

  
  *   :py:meth:`BucketWebsite()`

  
  *   :py:meth:`MultipartUpload()`

  
  *   :py:meth:`MultipartUploadPart()`

  
  *   :py:meth:`Object()`

  
  *   :py:meth:`ObjectAcl()`

  
  *   :py:meth:`ObjectSummary()`

  
  *   :py:meth:`ObjectVersion()`

  
  These are the resource's available collections:
  
  *   :py:attr:`buckets`

  
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: create_bucket(**kwargs)

    Creates a new bucket.

    **Request Syntax** 
    ::

      bucket = s3.create_bucket(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
          Bucket='string',
          CreateBucketConfiguration={
              'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
          },
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the bucket.

    
    :type Bucket: string
    :param Bucket: **[REQUIRED]** 

    
    :type CreateBucketConfiguration: dict
    :param CreateBucketConfiguration: 

    
      - **LocationConstraint** *(string) --* Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.

      
    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    
    :rtype: :py:class:`s3.Bucket`
    :returns: A Bucket resource
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket(name)

    Creates a Bucket resource.::

      bucket = s3.Bucket('name')

    :type name: string
    :param name: The Bucket's name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

  .. py:method:: BucketAcl(bucket_name)

    Creates a BucketAcl resource.::

      bucket_acl = s3.BucketAcl('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketAcl's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketAcl`
    :returns: A BucketAcl resource
    

  .. py:method:: BucketCors(bucket_name)

    Creates a BucketCors resource.::

      bucket_cors = s3.BucketCors('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketCors's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketCors`
    :returns: A BucketCors resource
    

  .. py:method:: BucketLifecycle(bucket_name)

    Creates a BucketLifecycle resource.::

      bucket_lifecycle = s3.BucketLifecycle('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketLifecycle's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketLifecycle`
    :returns: A BucketLifecycle resource
    

  .. py:method:: BucketLogging(bucket_name)

    Creates a BucketLogging resource.::

      bucket_logging = s3.BucketLogging('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketLogging's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketLogging`
    :returns: A BucketLogging resource
    

  .. py:method:: BucketNotification(bucket_name)

    Creates a BucketNotification resource.::

      bucket_notification = s3.BucketNotification('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketNotification's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketNotification`
    :returns: A BucketNotification resource
    

  .. py:method:: BucketPolicy(bucket_name)

    Creates a BucketPolicy resource.::

      bucket_policy = s3.BucketPolicy('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketPolicy's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketPolicy`
    :returns: A BucketPolicy resource
    

  .. py:method:: BucketRequestPayment(bucket_name)

    Creates a BucketRequestPayment resource.::

      bucket_request_payment = s3.BucketRequestPayment('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketRequestPayment's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketRequestPayment`
    :returns: A BucketRequestPayment resource
    

  .. py:method:: BucketTagging(bucket_name)

    Creates a BucketTagging resource.::

      bucket_tagging = s3.BucketTagging('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketTagging's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketTagging`
    :returns: A BucketTagging resource
    

  .. py:method:: BucketVersioning(bucket_name)

    Creates a BucketVersioning resource.::

      bucket_versioning = s3.BucketVersioning('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketVersioning's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketVersioning`
    :returns: A BucketVersioning resource
    

  .. py:method:: BucketWebsite(bucket_name)

    Creates a BucketWebsite resource.::

      bucket_website = s3.BucketWebsite('bucket_name')

    :type bucket_name: string
    :param bucket_name: The BucketWebsite's bucket_name identifier. This **must** be set.
    
    :rtype: :py:class:`S3.BucketWebsite`
    :returns: A BucketWebsite resource
    

  .. py:method:: MultipartUpload(bucket_name,object_key,id)

    Creates a MultipartUpload resource.::

      multipart_upload = s3.MultipartUpload('bucket_name','object_key','id')

    :type bucket_name: string
    :param bucket_name: The MultipartUpload's bucket_name identifier. This **must** be set.
    :type object_key: string
    :param object_key: The MultipartUpload's object_key identifier. This **must** be set.
    :type id: string
    :param id: The MultipartUpload's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.MultipartUpload`
    :returns: A MultipartUpload resource
    

  .. py:method:: MultipartUploadPart(bucket_name,object_key,multipart_upload_id,part_number)

    Creates a MultipartUploadPart resource.::

      multipart_upload_part = s3.MultipartUploadPart('bucket_name','object_key','multipart_upload_id','part_number')

    :type bucket_name: string
    :param bucket_name: The MultipartUploadPart's bucket_name identifier. This **must** be set.
    :type object_key: string
    :param object_key: The MultipartUploadPart's object_key identifier. This **must** be set.
    :type multipart_upload_id: string
    :param multipart_upload_id: The MultipartUploadPart's multipart_upload_id identifier. This **must** be set.
    :type part_number: string
    :param part_number: The MultipartUploadPart's part_number identifier. This **must** be set.
    
    :rtype: :py:class:`S3.MultipartUploadPart`
    :returns: A MultipartUploadPart resource
    

  .. py:method:: Object(bucket_name,key)

    Creates a Object resource.::

      object = s3.Object('bucket_name','key')

    :type bucket_name: string
    :param bucket_name: The Object's bucket_name identifier. This **must** be set.
    :type key: string
    :param key: The Object's key identifier. This **must** be set.
    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    

  .. py:method:: ObjectAcl(bucket_name,object_key)

    Creates a ObjectAcl resource.::

      object_acl = s3.ObjectAcl('bucket_name','object_key')

    :type bucket_name: string
    :param bucket_name: The ObjectAcl's bucket_name identifier. This **must** be set.
    :type object_key: string
    :param object_key: The ObjectAcl's object_key identifier. This **must** be set.
    
    :rtype: :py:class:`S3.ObjectAcl`
    :returns: A ObjectAcl resource
    

  .. py:method:: ObjectSummary(bucket_name,key)

    Creates a ObjectSummary resource.::

      object_summary = s3.ObjectSummary('bucket_name','key')

    :type bucket_name: string
    :param bucket_name: The ObjectSummary's bucket_name identifier. This **must** be set.
    :type key: string
    :param key: The ObjectSummary's key identifier. This **must** be set.
    
    :rtype: :py:class:`S3.ObjectSummary`
    :returns: A ObjectSummary resource
    

  .. py:method:: ObjectVersion(bucket_name,object_key,id)

    Creates a ObjectVersion resource.::

      object_version = s3.ObjectVersion('bucket_name','object_key','id')

    :type bucket_name: string
    :param bucket_name: The ObjectVersion's bucket_name identifier. This **must** be set.
    :type object_key: string
    :param object_key: The ObjectVersion's object_key identifier. This **must** be set.
    :type id: string
    :param id: The ObjectVersion's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.ObjectVersion`
    :returns: A ObjectVersion resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: buckets

    

    .. py:method:: all()

      Creates an iterable of all Bucket resources in the collection.

      **Request Syntax** 

      ::

        bucket_iterator = s3.buckets.all()
      :rtype: :py:class:`s3.Bucket`
      :returns: A Bucket resource
      

    .. py:method:: filter()

      Creates an iterable of all Bucket resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 

      ::

        bucket_iterator = s3.buckets.filter()
      :rtype: :py:class:`s3.Bucket`
      :returns: A Bucket resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Bucket resources in the collection.

      **Request Syntax** 

      ::

        bucket_iterator = s3.buckets.limit()
      :rtype: :py:class:`s3.Bucket`
      :returns: A Bucket resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Bucket resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 

      ::

        bucket_iterator = s3.buckets.page_size()
      :rtype: :py:class:`s3.Bucket`
      :returns: A Bucket resource
      

======
Bucket
======



.. py:class:: S3.Bucket(name)

  A resource representing an Amazon Simple Storage Service (S3) Bucket::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket = s3.Bucket('name')

  :type name: string
  :param name: The Bucket's name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`creation_date`

  
  These are the resource's available actions:
  
  *   :py:meth:`create()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`delete_objects()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put_object()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Acl()`

  
  *   :py:meth:`Cors()`

  
  *   :py:meth:`Lifecycle()`

  
  *   :py:meth:`Logging()`

  
  *   :py:meth:`Notification()`

  
  *   :py:meth:`Object()`

  
  *   :py:meth:`Policy()`

  
  *   :py:meth:`RequestPayment()`

  
  *   :py:meth:`Tagging()`

  
  *   :py:meth:`Versioning()`

  
  *   :py:meth:`Website()`

  
  These are the resource's available collections:
  
  *   :py:attr:`multipart_uploads`

  
  *   :py:attr:`object_versions`

  
  *   :py:attr:`objects`

  
  These are the resource's available waiters:
  
  *   :py:meth:`wait_until_exists()`

  
  *   :py:meth:`wait_until_not_exists()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: name

    *(string)* The Bucket's name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: creation_date

    *(datetime)* Date the bucket was created.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load(*args, **kwargs)

    

  .. py:method:: create(**kwargs)

    Creates a new bucket.

    **Request Syntax** 
    ::

      response = bucket.create(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
          CreateBucketConfiguration={
              'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
          },
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the bucket.

    
    :type CreateBucketConfiguration: dict
    :param CreateBucketConfiguration: 

    
      - **LocationConstraint** *(string) --* Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.

      
    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Location': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Location** *(string) --* 
    

  .. py:method:: delete()

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

    **Request Syntax** 
    ::

      response = bucket.delete()
      
    
    :returns: None

  .. py:method:: delete_objects(**kwargs)

    This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

    **Request Syntax** 
    ::

      response = bucket.delete_objects(
          Delete={
              'Objects': [
                  {
                      'Key': 'string',
                      'VersionId': 'string'
                  },
              ],
              'Quiet': True|False
          },
          MFA='string',
          RequestPayer='requester'
      )
    :type Delete: dict
    :param Delete: **[REQUIRED]** 

    
      - **Objects** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Key** *(string) --* **[REQUIRED]** Key name of the object to delete.

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

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :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) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **VersionId** *(string) --* 
            

            - **DeleteMarker** *(boolean) --* 
            

            - **DeleteMarkerVersionId** *(string) --* 
        
      
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **Errors** *(list) --* 
          

          - *(dict) --* 
            

            - **Key** *(string) --* 
            

            - **VersionId** *(string) --* 
            

            - **Code** *(string) --* 
            

            - **Message** *(string) --* 
        
      
        
    Calls s3.Client.list_buckets() to update the attributes of the Bucket resource.


    .. py:method:: put_object(**kwargs)

      Adds an object to a bucket.

      **Request Syntax** 
      ::

        object = bucket.put_object(
            ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
            Body=b'bytes',
            CacheControl='string',
            ContentDisposition='string',
            ContentEncoding='string',
            ContentLanguage='string',
            ContentLength=123,
            ContentMD5='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'|'LT',
            WebsiteRedirectLocation='string',
            SSECustomerAlgorithm='string',
            SSECustomerKey='string',
            SSEKMSKeyId='string',
            RequestPayer='requester'
        )
      :type ACL: string
      :param ACL: The canned ACL to apply to the object.

      
      :type Body: bytes
      :param Body: Object data.

      
      :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 ContentLength: integer
      :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

      
      :type ContentMD5: string
      :param ContentMD5: 

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

      
      :type GrantRead: string
      :param GrantRead: Allows grantee to read the object data and its metadata.

      
      :type GrantReadACP: string
      :param GrantReadACP: Allows grantee to read the object ACL.

      
      :type GrantWriteACP: string
      :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

      
      :type Key: string
      :param Key: **[REQUIRED]** 

      
      :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 S3 (e.g., AES256, aws:kms).

      
      :type StorageClass: string
      :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

      
      :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 (e.g., AES256).

      
      :type SSECustomerKey: string
      :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 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 the encryption key was transmitted without error.        Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



      
      :type SSEKMSKeyId: string
      :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

      
      :type RequestPayer: string
      :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

      
      
      :rtype: :py:class:`s3.Object`
      :returns: A Object resource
      
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Acl()

    Creates a BucketAcl resource.::

      bucket_acl = bucket.Acl()

    
    :rtype: :py:class:`S3.BucketAcl`
    :returns: A BucketAcl resource
    

  .. py:method:: Cors()

    Creates a BucketCors resource.::

      bucket_cors = bucket.Cors()

    
    :rtype: :py:class:`S3.BucketCors`
    :returns: A BucketCors resource
    

  .. py:method:: Lifecycle()

    Creates a BucketLifecycle resource.::

      bucket_lifecycle = bucket.Lifecycle()

    
    :rtype: :py:class:`S3.BucketLifecycle`
    :returns: A BucketLifecycle resource
    

  .. py:method:: Logging()

    Creates a BucketLogging resource.::

      bucket_logging = bucket.Logging()

    
    :rtype: :py:class:`S3.BucketLogging`
    :returns: A BucketLogging resource
    

  .. py:method:: Notification()

    Creates a BucketNotification resource.::

      bucket_notification = bucket.Notification()

    
    :rtype: :py:class:`S3.BucketNotification`
    :returns: A BucketNotification resource
    

  .. py:method:: Object(key)

    Creates a Object resource.::

      object = bucket.Object('key')

    :type key: string
    :param key: The Object's key identifier. This **must** be set.
    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    

  .. py:method:: Policy()

    Creates a BucketPolicy resource.::

      bucket_policy = bucket.Policy()

    
    :rtype: :py:class:`S3.BucketPolicy`
    :returns: A BucketPolicy resource
    

  .. py:method:: RequestPayment()

    Creates a BucketRequestPayment resource.::

      bucket_request_payment = bucket.RequestPayment()

    
    :rtype: :py:class:`S3.BucketRequestPayment`
    :returns: A BucketRequestPayment resource
    

  .. py:method:: Tagging()

    Creates a BucketTagging resource.::

      bucket_tagging = bucket.Tagging()

    
    :rtype: :py:class:`S3.BucketTagging`
    :returns: A BucketTagging resource
    

  .. py:method:: Versioning()

    Creates a BucketVersioning resource.::

      bucket_versioning = bucket.Versioning()

    
    :rtype: :py:class:`S3.BucketVersioning`
    :returns: A BucketVersioning resource
    

  .. py:method:: Website()

    Creates a BucketWebsite resource.::

      bucket_website = bucket.Website()

    
    :rtype: :py:class:`S3.BucketWebsite`
    :returns: A BucketWebsite resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: multipart_uploads

    

    .. py:method:: all()

      Creates an iterable of all MultipartUpload resources in the collection.

      **Request Syntax** 
      ::

        multipart_upload_iterator = bucket.multipart_uploads.all()
        
      
      :rtype: :py:class:`s3.MultipartUpload`
      :returns: A MultipartUpload resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all MultipartUpload resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        multipart_upload_iterator = bucket.multipart_uploads.filter(
            Delimiter='string',
            EncodingType='url',
            KeyMarker='string',
            MaxUploads=123,
            Prefix='string',
            UploadIdMarker='string'
        )
      :type Delimiter: string
      :param Delimiter: 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 KeyMarker: string
      :param KeyMarker: Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

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

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

      
      
      :rtype: :py:class:`s3.MultipartUpload`
      :returns: A MultipartUpload resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of MultipartUpload resources in the collection.

      **Request Syntax** 
      ::

        multipart_upload_iterator = bucket.multipart_uploads.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`s3.MultipartUpload`
      :returns: A MultipartUpload resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all MultipartUpload resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        multipart_upload_iterator = bucket.multipart_uploads.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`s3.MultipartUpload`
      :returns: A MultipartUpload resource
      

  .. py:attribute:: object_versions

    

    .. py:method:: all()

      Creates an iterable of all ObjectVersion resources in the collection.

      **Request Syntax** 
      ::

        object_version_iterator = bucket.object_versions.all()
        
      
      :rtype: :py:class:`s3.ObjectVersion`
      :returns: A ObjectVersion resource
      

    .. py:method:: delete(**kwargs)

      This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

      **Request Syntax** 
      ::

        response = bucket.object_versions.delete(
            MFA='string',
            RequestPayer='requester'
        )
      :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.

      
      :type RequestPayer: string
      :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

      
      
      :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) --* 
            

            - *(dict) --* 
              

              - **Key** *(string) --* 
              

              - **VersionId** *(string) --* 
              

              - **DeleteMarker** *(boolean) --* 
              

              - **DeleteMarkerVersionId** *(string) --* 
          
        
          

          - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
          

          - **Errors** *(list) --* 
            

            - *(dict) --* 
              

              - **Key** *(string) --* 
              

              - **VersionId** *(string) --* 
              

              - **Code** *(string) --* 
              

              - **Message** *(string) --* 
          
        
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all ObjectVersion resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        object_version_iterator = bucket.object_versions.filter(
            Delimiter='string',
            EncodingType='url',
            KeyMarker='string',
            MaxKeys=123,
            Prefix='string',
            VersionIdMarker='string'
        )
      :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 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. 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 VersionIdMarker: string
      :param VersionIdMarker: Specifies the object version you want to start listing from.

      
      
      :rtype: :py:class:`s3.ObjectVersion`
      :returns: A ObjectVersion resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of ObjectVersion resources in the collection.

      **Request Syntax** 
      ::

        object_version_iterator = bucket.object_versions.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`s3.ObjectVersion`
      :returns: A ObjectVersion resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all ObjectVersion resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        object_version_iterator = bucket.object_versions.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`s3.ObjectVersion`
      :returns: A ObjectVersion resource
      

  .. py:attribute:: objects

    

    .. py:method:: all()

      Creates an iterable of all ObjectSummary resources in the collection.

      **Request Syntax** 
      ::

        object_summary_iterator = bucket.objects.all()
        
      
      :rtype: :py:class:`s3.ObjectSummary`
      :returns: A ObjectSummary resource
      

    .. py:method:: delete(**kwargs)

      This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

      **Request Syntax** 
      ::

        response = bucket.objects.delete(
            MFA='string',
            RequestPayer='requester'
        )
      :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.

      
      :type RequestPayer: string
      :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

      
      
      :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) --* 
            

            - *(dict) --* 
              

              - **Key** *(string) --* 
              

              - **VersionId** *(string) --* 
              

              - **DeleteMarker** *(boolean) --* 
              

              - **DeleteMarkerVersionId** *(string) --* 
          
        
          

          - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
          

          - **Errors** *(list) --* 
            

            - *(dict) --* 
              

              - **Key** *(string) --* 
              

              - **VersionId** *(string) --* 
              

              - **Code** *(string) --* 
              

              - **Message** *(string) --* 
          
        
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all ObjectSummary resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        object_summary_iterator = bucket.objects.filter(
            Delimiter='string',
            EncodingType='url',
            Marker='string',
            MaxKeys=123,
            Prefix='string'
        )
      :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: 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. 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.

      
      
      :rtype: :py:class:`s3.ObjectSummary`
      :returns: A ObjectSummary resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of ObjectSummary resources in the collection.

      **Request Syntax** 
      ::

        object_summary_iterator = bucket.objects.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`s3.ObjectSummary`
      :returns: A ObjectSummary resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all ObjectSummary resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        object_summary_iterator = bucket.objects.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`s3.ObjectSummary`
      :returns: A ObjectSummary resource
      
  .. rst-class:: admonition-title
  
  Waiters
  
  Waiters provide an interface to wait for a resource to reach a specific state.
  For more information about waiters refer to the :ref:`Resources Introduction Guide<waiters_intro>`.
  

  .. py:method:: wait_until_exists()

    Waits until this Bucket is exists. This method calls :py:meth:`S3.Waiter.bucket_exists.wait` which polls. :py:meth:`S3.Client.head_bucket` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      bucket.wait_until_exists()
      
    
    :returns: None

  .. py:method:: wait_until_not_exists()

    Waits until this Bucket is not exists. This method calls :py:meth:`S3.Waiter.bucket_not_exists.wait` which polls. :py:meth:`S3.Client.head_bucket` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      bucket.wait_until_not_exists()
      
    
    :returns: None

=========
BucketAcl
=========



.. py:class:: S3.BucketAcl(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketAcl::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_acl = s3.BucketAcl('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketAcl's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`owner`

  
  *   :py:attr:`grants`

  
  These are the resource's available actions:
  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketAcl's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: owner

    *(dict)* 

  .. py:attribute:: grants

    *(list)* A list of grants.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_acl` to update the attributes of the BucketAcl resource

    **Request Syntax** 

    ::

      bucket_acl.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets the permissions on a bucket using access control lists (ACL).

    **Request Syntax** 
    ::

      response = bucket_acl.put(
          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'
              }
          },
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the bucket.

    
    :type AccessControlPolicy: dict
    :param AccessControlPolicy: 

    
      - **Grants** *(list) --* A list of grants.

      
        - *(dict) --* 

        
          - **Grantee** *(dict) --* 

          
            - **DisplayName** *(string) --* Screen name of the grantee.

            
            - **EmailAddress** *(string) --* Email address of the grantee.

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

      
        - **DisplayName** *(string) --* 

        
        - **ID** *(string) --* 

        
      
    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_acl` to update the attributes of the BucketAcl resource

    **Request Syntax** 

    ::

      bucket_acl.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_acl.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

==========
BucketCors
==========



.. py:class:: S3.BucketCors(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketCors::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_cors = s3.BucketCors('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketCors's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`cors_rules`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketCors's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: cors_rules

    *(list)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    Deletes the cors configuration information set for the bucket.

    **Request Syntax** 
    ::

      response = bucket_cors.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_cors` to update the attributes of the BucketCors resource

    **Request Syntax** 

    ::

      bucket_cors.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets the cors configuration for a bucket.

    **Request Syntax** 
    ::

      response = bucket_cors.put(
          CORSConfiguration={
              'CORSRules': [
                  {
                      'AllowedHeaders': [
                          'string',
                      ],
                      'AllowedMethods': [
                          'string',
                      ],
                      'AllowedOrigins': [
                          'string',
                      ],
                      'ExposeHeaders': [
                          'string',
                      ],
                      'MaxAgeSeconds': 123
                  },
              ]
          },
          
      )
    :type CORSConfiguration: dict
    :param CORSConfiguration: 

    
      - **CORSRules** *(list) --* 

      
        - *(dict) --* 

        
          - **AllowedHeaders** *(list) --* Specifies which headers are allowed in a pre-flight OPTIONS request.

          
            - *(string) --* 

            
        
          - **AllowedMethods** *(list) --* Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.

          
            - *(string) --* 

            
        
          - **AllowedOrigins** *(list) --* 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.

          
        
    
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_cors` to update the attributes of the BucketCors resource

    **Request Syntax** 

    ::

      bucket_cors.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_cors.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

===============
BucketLifecycle
===============



.. py:class:: S3.BucketLifecycle(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketLifecycle::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_lifecycle = s3.BucketLifecycle('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketLifecycle's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`rules`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketLifecycle's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: rules

    *(list)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    Deletes the lifecycle configuration from the bucket.

    **Request Syntax** 
    ::

      response = bucket_lifecycle.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_lifecycle` to update the attributes of the BucketLifecycle resource

    **Request Syntax** 

    ::

      bucket_lifecycle.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

    **Request Syntax** 
    ::

      response = bucket_lifecycle.put(
          LifecycleConfiguration={
              'Rules': [
                  {
                      'Expiration': {
                          'Date': datetime(2015, 1, 1),
                          'Days': 123
                      },
                      'ID': 'string',
                      'Prefix': 'string',
                      'Status': 'Enabled'|'Disabled',
                      'Transition': {
                          'Date': datetime(2015, 1, 1),
                          'Days': 123,
                          'StorageClass': 'GLACIER'
                      },
                      'NoncurrentVersionTransition': {
                          'NoncurrentDays': 123,
                          'StorageClass': 'GLACIER'
                      },
                      'NoncurrentVersionExpiration': {
                          'NoncurrentDays': 123
                      }
                  },
              ]
          }
      )
    :type LifecycleConfiguration: dict
    :param LifecycleConfiguration: 

    
      - **Rules** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Expiration** *(dict) --* 

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

            
          
          - **ID** *(string) --* Unique identifier for the rule. The value cannot be longer than 255 characters.

          
          - **Prefix** *(string) --* **[REQUIRED]** Prefix identifying one or more objects 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.

          
          - **Transition** *(dict) --* 

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

            
            - **StorageClass** *(string) --* The class of storage used to store the object.

            
          
          - **NoncurrentVersionTransition** *(dict) --* Container for the transition rule that describes when noncurrent objects transition to the GLACIER 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 GLACIER 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 When an Object Became Noncurrent`_ in the Amazon Simple Storage Service Developer Guide.

            
            - **StorageClass** *(string) --* The class of storage used to store the object.

            
          
          - **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 Simple Storage Service Developer Guide.

            
          
        
    
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_lifecycle` to update the attributes of the BucketLifecycle resource

    **Request Syntax** 

    ::

      bucket_lifecycle.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_lifecycle.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

=============
BucketLogging
=============



.. py:class:: S3.BucketLogging(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketLogging::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_logging = s3.BucketLogging('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketLogging's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`logging_enabled`

  
  These are the resource's available actions:
  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketLogging's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: logging_enabled

    *(dict)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_logging` to update the attributes of the BucketLogging resource

    **Request Syntax** 

    ::

      bucket_logging.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = bucket_logging.put(
          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'
              }
          },
          
      )
    :type BucketLoggingStatus: dict
    :param BucketLoggingStatus: **[REQUIRED]** 

    
      - **LoggingEnabled** *(dict) --* 

      
        - **TargetBucket** *(string) --* 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) --* 

        
          - *(dict) --* 

          
            - **Grantee** *(dict) --* 

            
              - **DisplayName** *(string) --* Screen name of the grantee.

              
              - **EmailAddress** *(string) --* Email address of the grantee.

              
              - **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) --* This element lets you specify a prefix for the keys that the log files will be stored under.

        
      
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_logging` to update the attributes of the BucketLogging resource

    **Request Syntax** 

    ::

      bucket_logging.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_logging.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

==================
BucketNotification
==================



.. py:class:: S3.BucketNotification(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketNotification::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_notification = s3.BucketNotification('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketNotification's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`lambda_function_configurations`

  
  *   :py:attr:`topic_configurations`

  
  *   :py:attr:`queue_configurations`

  
  These are the resource's available actions:
  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketNotification's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: lambda_function_configurations

    *(list)* 

  .. py:attribute:: topic_configurations

    *(list)* 

  .. py:attribute:: queue_configurations

    *(list)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_notification_configuration` to update the attributes of the BucketNotification resource

    **Request Syntax** 

    ::

      bucket_notification.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Enables notifications of specified events for a bucket.

    **Request Syntax** 
    ::

      response = bucket_notification.put(
          NotificationConfiguration={
              'TopicConfigurations': [
                  {
                      'Id': 'string',
                      'TopicArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ],
              'QueueConfigurations': [
                  {
                      'Id': 'string',
                      'QueueArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ],
              'LambdaFunctionConfigurations': [
                  {
                      'Id': 'string',
                      'LambdaFunctionArn': 'string',
                      'Events': [
                          's3:ReducedRedundancyLostObject'|'s3:ObjectCreated:*'|'s3:ObjectCreated:Put'|'s3:ObjectCreated:Post'|'s3:ObjectCreated:Copy'|'s3:ObjectCreated:CompleteMultipartUpload'|'s3:ObjectRemoved:*'|'s3:ObjectRemoved:Delete'|'s3:ObjectRemoved:DeleteMarkerCreated',
                      ]
                  },
              ]
          }
      )
    :type NotificationConfiguration: dict
    :param NotificationConfiguration: **[REQUIRED]** Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.

    
      - **TopicConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **TopicArn** *(string) --* **[REQUIRED]** Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
      - **QueueConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **QueueArn** *(string) --* **[REQUIRED]** Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
      - **LambdaFunctionConfigurations** *(list) --* 

      
        - *(dict) --* Container for specifying the AWS Lambda notification configuration.

        
          - **Id** *(string) --* Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

          
          - **LambdaFunctionArn** *(string) --* **[REQUIRED]** Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

          
          - **Events** *(list) --* **[REQUIRED]** 

          
            - *(string) --* Bucket event for which to send notifications.

            
        
        
    
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_notification_configuration` to update the attributes of the BucketNotification resource

    **Request Syntax** 

    ::

      bucket_notification.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_notification.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

============
BucketPolicy
============



.. py:class:: S3.BucketPolicy(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketPolicy::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_policy = s3.BucketPolicy('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketPolicy's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`policy`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketPolicy's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: policy

    *(string)* The bucket policy as a JSON document.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    Deletes the policy from the bucket.

    **Request Syntax** 
    ::

      response = bucket_policy.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_policy` to update the attributes of the BucketPolicy resource

    **Request Syntax** 

    ::

      bucket_policy.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

    **Request Syntax** 
    ::

      response = bucket_policy.put(
          Policy='string'
      )
    :type Policy: string
    :param Policy: **[REQUIRED]** The bucket policy as a JSON document.

    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_policy` to update the attributes of the BucketPolicy resource

    **Request Syntax** 

    ::

      bucket_policy.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_policy.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

====================
BucketRequestPayment
====================



.. py:class:: S3.BucketRequestPayment(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketRequestPayment::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_request_payment = s3.BucketRequestPayment('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketRequestPayment's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`payer`

  
  These are the resource's available actions:
  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketRequestPayment's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: payer

    *(string)* Specifies who pays for the download and request fees.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_request_payment` to update the attributes of the BucketRequestPayment resource

    **Request Syntax** 

    ::

      bucket_request_payment.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

    **Request Syntax** 
    ::

      response = bucket_request_payment.put(
          RequestPaymentConfiguration={
              'Payer': 'Requester'|'BucketOwner'
          }
      )
    :type RequestPaymentConfiguration: dict
    :param RequestPaymentConfiguration: **[REQUIRED]** 

    
      - **Payer** *(string) --* **[REQUIRED]** Specifies who pays for the download and request fees.

      
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_request_payment` to update the attributes of the BucketRequestPayment resource

    **Request Syntax** 

    ::

      bucket_request_payment.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_request_payment.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

=============
BucketTagging
=============



.. py:class:: S3.BucketTagging(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketTagging::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_tagging = s3.BucketTagging('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketTagging's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`tag_set`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketTagging's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: tag_set

    *(list)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    Deletes the tags from the bucket.

    **Request Syntax** 
    ::

      response = bucket_tagging.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_tagging` to update the attributes of the BucketTagging resource

    **Request Syntax** 

    ::

      bucket_tagging.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets the tags for a bucket.

    **Request Syntax** 
    ::

      response = bucket_tagging.put(
          Tagging={
              'TagSet': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      )
    :type Tagging: dict
    :param Tagging: **[REQUIRED]** 

    
      - **TagSet** *(list) --* **[REQUIRED]** 

      
        - *(dict) --* 

        
          - **Key** *(string) --* **[REQUIRED]** Name of the tag.

          
          - **Value** *(string) --* **[REQUIRED]** Value of the tag.

          
        
    
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_tagging` to update the attributes of the BucketTagging resource

    **Request Syntax** 

    ::

      bucket_tagging.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_tagging.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

================
BucketVersioning
================



.. py:class:: S3.BucketVersioning(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketVersioning::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_versioning = s3.BucketVersioning('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketVersioning's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`status`

  
  *   :py:attr:`mfa_delete`

  
  These are the resource's available actions:
  
  *   :py:meth:`enable()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`suspend()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketVersioning's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: status

    *(string)* The versioning state of the bucket.

  .. py:attribute:: mfa_delete

    *(string)* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: enable(**kwargs)

    Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = bucket_versioning.enable(
          MFA='string',
          
      )
    :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.

    
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_versioning` to update the attributes of the BucketVersioning resource

    **Request Syntax** 

    ::

      bucket_versioning.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = bucket_versioning.put(
          MFA='string',
          VersioningConfiguration={
              'MFADelete': 'Enabled'|'Disabled',
              'Status': 'Enabled'|'Suspended'
          }
      )
    :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.

    
    :type VersioningConfiguration: dict
    :param VersioningConfiguration: **[REQUIRED]** 

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

      
      - **Status** *(string) --* The versioning state of the bucket.

      
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_versioning` to update the attributes of the BucketVersioning resource

    **Request Syntax** 

    ::

      bucket_versioning.reload()
    :returns: None

  .. py:method:: suspend(**kwargs)

    Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

    **Request Syntax** 
    ::

      response = bucket_versioning.suspend(
          MFA='string',
          
      )
    :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.

    
    
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_versioning.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

=============
BucketWebsite
=============



.. py:class:: S3.BucketWebsite(bucket_name)

  A resource representing an Amazon Simple Storage Service (S3) BucketWebsite::

    
    import boto3
    
    s3 = boto3.resource('s3')
    bucket_website = s3.BucketWebsite('bucket_name')

  :type bucket_name: string
  :param bucket_name: The BucketWebsite's bucket_name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`routing_rules`

  
  *   :py:attr:`redirect_all_requests_to`

  
  *   :py:attr:`error_document`

  
  *   :py:attr:`index_document`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Bucket()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The BucketWebsite's bucket_name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: routing_rules

    *(list)* 

  .. py:attribute:: redirect_all_requests_to

    *(dict)* 

  .. py:attribute:: error_document

    *(dict)* 

  .. py:attribute:: index_document

    *(dict)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete()

    This operation removes the website configuration from the bucket.

    **Request Syntax** 
    ::

      response = bucket_website.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_bucket_website` to update the attributes of the BucketWebsite resource

    **Request Syntax** 

    ::

      bucket_website.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Set the website configuration for a bucket.

    **Request Syntax** 
    ::

      response = bucket_website.put(
          WebsiteConfiguration={
              'ErrorDocument': {
                  'Key': 'string'
              },
              'IndexDocument': {
                  'Suffix': 'string'
              },
              'RedirectAllRequestsTo': {
                  'HostName': 'string',
                  'Protocol': 'http'|'https'
              },
              'RoutingRules': [
                  {
                      'Condition': {
                          'HttpErrorCodeReturnedEquals': 'string',
                          'KeyPrefixEquals': 'string'
                      },
                      'Redirect': {
                          'HostName': 'string',
                          'HttpRedirectCode': 'string',
                          'Protocol': 'http'|'https',
                          'ReplaceKeyPrefixWith': 'string',
                          'ReplaceKeyWith': 'string'
                      }
                  },
              ]
          }
      )
    :type WebsiteConfiguration: dict
    :param WebsiteConfiguration: **[REQUIRED]** 

    
      - **ErrorDocument** *(dict) --* 

      
        - **Key** *(string) --* **[REQUIRED]** The object key name to use when a 4XX class error occurs.

        
      
      - **IndexDocument** *(dict) --* 

      
        - **Suffix** *(string) --* **[REQUIRED]** A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

        
      
      - **RedirectAllRequestsTo** *(dict) --* 

      
        - **HostName** *(string) --* **[REQUIRED]** Name of the host where requests will be redirected.

        
        - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

        
      
      - **RoutingRules** *(list) --* 

      
        - *(dict) --* 

        
          - **Condition** *(dict) --* A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

          
            - **HttpErrorCodeReturnedEquals** *(string) --* The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

            
            - **KeyPrefixEquals** *(string) --* The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

            
          
          - **Redirect** *(dict) --* **[REQUIRED]** Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.

          
            - **HostName** *(string) --* The host name to use in the redirect request.

            
            - **HttpRedirectCode** *(string) --* The HTTP redirect code to use on the response. Not required if one of the siblings is present.

            
            - **Protocol** *(string) --* Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

            
            - **ReplaceKeyPrefixWith** *(string) --* The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

            
            - **ReplaceKeyWith** *(string) --* The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

            
          
        
    
    
    
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_bucket_website` to update the attributes of the BucketWebsite resource

    **Request Syntax** 

    ::

      bucket_website.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = bucket_website.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

===============
MultipartUpload
===============



.. py:class:: S3.MultipartUpload(bucket_name,object_key,id)

  A resource representing an Amazon Simple Storage Service (S3) MultipartUpload::

    
    import boto3
    
    s3 = boto3.resource('s3')
    multipart_upload = s3.MultipartUpload('bucket_name','object_key','id')

  :type bucket_name: string
  :param bucket_name: The MultipartUpload's bucket_name identifier. This **must** be set.
  :type object_key: string
  :param object_key: The MultipartUpload's object_key identifier. This **must** be set.
  :type id: string
  :param id: The MultipartUpload's id identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`object_key`

  
  *   :py:attr:`id`

  
  These are the resource's available attributes:
  
  *   :py:attr:`initiator`

  
  *   :py:attr:`initiated`

  
  *   :py:attr:`storage_class`

  
  *   :py:attr:`upload_id`

  
  *   :py:attr:`key`

  
  *   :py:attr:`owner`

  
  These are the resource's available actions:
  
  *   :py:meth:`abort()`

  
  *   :py:meth:`complete()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Object()`

  
  *   :py:meth:`Part()`

  
  These are the resource's available collections:
  
  *   :py:attr:`parts`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The MultipartUpload's bucket_name identifier. This **must** be set.

  .. py:attribute:: object_key

    *(string)* The MultipartUpload's object_key identifier. This **must** be set.

  .. py:attribute:: id

    *(string)* The MultipartUpload's id identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: initiator

    *(dict)* Identifies who initiated the multipart upload.

  .. py:attribute:: initiated

    *(datetime)* Date and time at which the multipart upload was initiated.

  .. py:attribute:: storage_class

    *(string)* The class of storage used to store the object.

  .. py:attribute:: upload_id

    *(string)* Upload ID that identifies the multipart upload.

  .. py:attribute:: key

    *(string)* Key of the object for which the multipart upload was initiated.

  .. py:attribute:: owner

    *(dict)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: abort(**kwargs)

    

    Aborts a multipart upload.

     

    To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

    

    **Request Syntax** 
    ::

      response = multipart_upload.abort(
          RequestPayer='requester'
      )
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: complete(**kwargs)

    Completes a multipart upload by assembling previously uploaded parts.

    **Request Syntax** 
    ::

      object = multipart_upload.complete(
          MultipartUpload={
              'Parts': [
                  {
                      'ETag': 'string',
                      'PartNumber': 123
                  },
              ]
          },
          RequestPayer='requester'
      )
    :type MultipartUpload: dict
    :param MultipartUpload: 

    
      - **Parts** *(list) --* 

      
        - *(dict) --* 

        
          - **ETag** *(string) --* Entity tag returned when the part was uploaded.

          
          - **PartNumber** *(integer) --* Part number that identifies the part. This is a positive integer between 1 and 10,000.

          
        
    
    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: :py:class:`s3.Object`
    :returns: A Object resource
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Object()

    Creates a Object resource.::

      object = multipart_upload.Object()

    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    

  .. py:method:: Part(part_number)

    Creates a MultipartUploadPart resource.::

      multipart_upload_part = multipart_upload.Part('part_number')

    :type part_number: string
    :param part_number: The Part's part_number identifier. This **must** be set.
    
    :rtype: :py:class:`S3.MultipartUploadPart`
    :returns: A MultipartUploadPart resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: parts

    

    .. py:method:: all()

      Creates an iterable of all MultipartUploadPart resources in the collection.

      **Request Syntax** 
      ::

        multipart_upload_part_iterator = multipart_upload.parts.all()
        
      
      :rtype: :py:class:`s3.MultipartUploadPart`
      :returns: A MultipartUploadPart resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all MultipartUploadPart resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        multipart_upload_part_iterator = multipart_upload.parts.filter(
            MaxParts=123,
            PartNumberMarker=123,
            RequestPayer='requester'
        )
      :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 RequestPayer: string
      :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

      
      
      :rtype: :py:class:`s3.MultipartUploadPart`
      :returns: A MultipartUploadPart resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of MultipartUploadPart resources in the collection.

      **Request Syntax** 
      ::

        multipart_upload_part_iterator = multipart_upload.parts.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`s3.MultipartUploadPart`
      :returns: A MultipartUploadPart resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all MultipartUploadPart resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        multipart_upload_part_iterator = multipart_upload.parts.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`s3.MultipartUploadPart`
      :returns: A MultipartUploadPart resource
      

===================
MultipartUploadPart
===================



.. py:class:: S3.MultipartUploadPart(bucket_name,object_key,multipart_upload_id,part_number)

  A resource representing an Amazon Simple Storage Service (S3) MultipartUploadPart::

    
    import boto3
    
    s3 = boto3.resource('s3')
    multipart_upload_part = s3.MultipartUploadPart('bucket_name','object_key','multipart_upload_id','part_number')

  :type bucket_name: string
  :param bucket_name: The MultipartUploadPart's bucket_name identifier. This **must** be set.
  :type object_key: string
  :param object_key: The MultipartUploadPart's object_key identifier. This **must** be set.
  :type multipart_upload_id: string
  :param multipart_upload_id: The MultipartUploadPart's multipart_upload_id identifier. This **must** be set.
  :type part_number: string
  :param part_number: The MultipartUploadPart's part_number identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`object_key`

  
  *   :py:attr:`multipart_upload_id`

  
  *   :py:attr:`part_number`

  
  These are the resource's available attributes:
  
  *   :py:attr:`last_modified`

  
  *   :py:attr:`e_tag`

  
  *   :py:attr:`size`

  
  These are the resource's available actions:
  
  *   :py:meth:`copy_from()`

  
  *   :py:meth:`upload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`MultipartUpload()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The MultipartUploadPart's bucket_name identifier. This **must** be set.

  .. py:attribute:: object_key

    *(string)* The MultipartUploadPart's object_key identifier. This **must** be set.

  .. py:attribute:: multipart_upload_id

    *(string)* The MultipartUploadPart's multipart_upload_id identifier. This **must** be set.

  .. py:attribute:: part_number

    *(string)* The MultipartUploadPart's part_number identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: last_modified

    *(datetime)* Date and time at which the part was uploaded.

  .. py:attribute:: e_tag

    *(string)* Entity tag returned when the part was uploaded.

  .. py:attribute:: size

    *(integer)* Size of the uploaded part data.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: copy_from(**kwargs)

    Uploads a part by copying data from an existing object as data source.

    **Request Syntax** 
    ::

      response = multipart_upload_part.copy_from(
          CopySource='string',
          CopySourceIfMatch='string',
          CopySourceIfModifiedSince=datetime(2015, 1, 1),
          CopySourceIfNoneMatch='string',
          CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
          CopySourceRange='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          CopySourceSSECustomerAlgorithm='string',
          CopySourceSSECustomerKey='string',
          CopySourceSSECustomerKeyMD5='string',
          RequestPayer='requester'
      )
    :type CopySource: string
    :param CopySource: **[REQUIRED]** The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    
    :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 CopySourceRange: string
    :param CopySourceRange: The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.

    
    :type SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    
    :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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type CopySourceSSECustomerAlgorithm: string
    :param CopySourceSSECustomerAlgorithm: Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    
    :type CopySourceSSECustomerKey: string
    :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 the encryption key was transmitted without error.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CopySourceVersionId': 'string',
            'CopyPartResult': {
                'ETag': 'string',
                'LastModified': datetime(2015, 1, 1)
            },
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CopySourceVersionId** *(string) --* The version of the source object that was copied, if you have enabled versioning on the source bucket.
        

        - **CopyPartResult** *(dict) --* 
          

          - **ETag** *(string) --* Entity tag of the object.
          

          - **LastModified** *(datetime) --* Date and time at which the object was uploaded.
      
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: upload(**kwargs)

    

    Uploads a part in a multipart upload.

     

    **Note:** After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    

    **Request Syntax** 
    ::

      response = multipart_upload_part.upload(
          Body=b'bytes',
          ContentLength=123,
          ContentMD5='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :type Body: bytes
    :param Body: 

    
    :type ContentLength: integer
    :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    
    :type ContentMD5: string
    :param ContentMD5: 

    
    :type SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    
    :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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'ETag': 'string',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **ETag** *(string) --* Entity tag for the uploaded object.
        

        - **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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: MultipartUpload()

    Creates a MultipartUpload resource.::

      multipart_upload = multipart_upload_part.MultipartUpload()

    
    :rtype: :py:class:`S3.MultipartUpload`
    :returns: A MultipartUpload resource
    

======
Object
======



.. py:class:: S3.Object(bucket_name,key)

  A resource representing an Amazon Simple Storage Service (S3) Object::

    
    import boto3
    
    s3 = boto3.resource('s3')
    object = s3.Object('bucket_name','key')

  :type bucket_name: string
  :param bucket_name: The Object's bucket_name identifier. This **must** be set.
  :type key: string
  :param key: The Object's key identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`key`

  
  These are the resource's available attributes:
  
  *   :py:attr:`content_length`

  
  *   :py:attr:`restore`

  
  *   :py:attr:`sse_customer_key_md5`

  
  *   :py:attr:`content_language`

  
  *   :py:attr:`replication_status`

  
  *   :py:attr:`server_side_encryption`

  
  *   :py:attr:`sse_customer_algorithm`

  
  *   :py:attr:`missing_meta`

  
  *   :py:attr:`delete_marker`

  
  *   :py:attr:`content_encoding`

  
  *   :py:attr:`content_disposition`

  
  *   :py:attr:`cache_control`

  
  *   :py:attr:`metadata`

  
  *   :py:attr:`request_charged`

  
  *   :py:attr:`e_tag`

  
  *   :py:attr:`expires`

  
  *   :py:attr:`version_id`

  
  *   :py:attr:`last_modified`

  
  *   :py:attr:`content_type`

  
  *   :py:attr:`website_redirect_location`

  
  *   :py:attr:`ssekms_key_id`

  
  *   :py:attr:`accept_ranges`

  
  *   :py:attr:`storage_class`

  
  *   :py:attr:`expiration`

  
  These are the resource's available actions:
  
  *   :py:meth:`copy_from()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`get()`

  
  *   :py:meth:`initiate_multipart_upload()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Acl()`

  
  *   :py:meth:`Bucket()`

  
  *   :py:meth:`MultipartUpload()`

  
  *   :py:meth:`Version()`

  
  These are the resource's available waiters:
  
  *   :py:meth:`wait_until_exists()`

  
  *   :py:meth:`wait_until_not_exists()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The Object's bucket_name identifier. This **must** be set.

  .. py:attribute:: key

    *(string)* The Object's key identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: content_length

    *(integer)* Size of the body in bytes.

  .. py:attribute:: restore

    *(string)* Provides information about object restoration operation and expiration time of the restored object copy.

  .. py:attribute:: sse_customer_key_md5

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

  .. py:attribute:: content_language

    *(string)* The language the content is in.

  .. py:attribute:: replication_status

    *(string)* 

  .. py:attribute:: server_side_encryption

    *(string)* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

  .. py:attribute:: sse_customer_algorithm

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

  .. py:attribute:: missing_meta

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

  .. py:attribute:: delete_marker

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

  .. py:attribute:: content_encoding

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

  .. py:attribute:: content_disposition

    *(string)* Specifies presentational information for the object.

  .. py:attribute:: cache_control

    *(string)* Specifies caching behavior along the request/reply chain.

  .. py:attribute:: metadata

    *(dict)* A map of metadata to store with the object in S3.

  .. py:attribute:: request_charged

    *(string)* If present, indicates that the requester was successfully charged for the request.

  .. py:attribute:: e_tag

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

  .. py:attribute:: expires

    *(datetime)* The date and time at which the object is no longer cacheable.

  .. py:attribute:: version_id

    *(string)* Version of the object.

  .. py:attribute:: last_modified

    *(datetime)* Last modified date of the object

  .. py:attribute:: content_type

    *(string)* A standard MIME type describing the format of the object data.

  .. py:attribute:: website_redirect_location

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

  .. py:attribute:: ssekms_key_id

    *(string)* If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

  .. py:attribute:: accept_ranges

    *(string)* 

  .. py:attribute:: storage_class

    *(string)* 

  .. py:attribute:: 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.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: copy_from(**kwargs)

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

    **Request Syntax** 
    ::

      response = object.copy_from(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          CacheControl='string',
          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',
          Metadata={
              'string': 'string'
          },
          MetadataDirective='COPY'|'REPLACE',
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          CopySourceSSECustomerAlgorithm='string',
          CopySourceSSECustomerKey='string',
          CopySourceSSECustomerKeyMD5='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :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 CopySource: string
    :param CopySource: **[REQUIRED]** The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable 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 ServerSideEncryption: string
    :param ServerSideEncryption: The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type CopySourceSSECustomerAlgorithm: string
    :param CopySourceSSECustomerAlgorithm: Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    
    :type CopySourceSSECustomerKey: string
    :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 the encryption key was transmitted without error.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CopyObjectResult': {
                'ETag': 'string',
                'LastModified': datetime(2015, 1, 1)
            },
            'Expiration': 'string',
            'CopySourceVersionId': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CopyObjectResult** *(dict) --* 
          

          - **ETag** *(string) --* 
          

          - **LastModified** *(datetime) --* 
      
        

        - **Expiration** *(string) --* If the object expiration is configured, the response includes this header.
        

        - **CopySourceVersionId** *(string) --* 
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: delete(**kwargs)

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

    **Request Syntax** 
    ::

      response = object.delete(
          MFA='string',
          VersionId='string',
          RequestPayer='requester'
      )
    :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.

    
    :type VersionId: string
    :param VersionId: VersionId used to reference a specific version of the object.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'VersionId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

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

        - **VersionId** *(string) --* Returns the version ID of the delete marker created as a result of the DELETE operation.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: get(**kwargs)

    Retrieves objects from Amazon S3.

    **Request Syntax** 
    ::

      response = object.get(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          ResponseCacheControl='string',
          ResponseContentDisposition='string',
          ResponseContentEncoding='string',
          ResponseContentLanguage='string',
          ResponseContentType='string',
          ResponseExpires=datetime(2015, 1, 1),
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Body': b'bytes',
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            'ETag': '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Body** *(bytes) --* 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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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.
        

        - **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 S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: initiate_multipart_upload(**kwargs)

    

    Initiates a multipart upload and returns an upload ID.

     

    **Note:** After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    

    **Request Syntax** 
    ::

      multipart_upload = object.initiate_multipart_upload(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          CacheControl='string',
          ContentDisposition='string',
          ContentEncoding='string',
          ContentLanguage='string',
          ContentType='string',
          Expires=datetime(2015, 1, 1),
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWriteACP='string',
          Metadata={
              'string': 'string'
          },
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: :py:class:`s3.MultipartUpload`
    :returns: A MultipartUpload resource
    

  .. py:method:: load()

    Calls :py:meth:`s3.Client.head_object` to update the attributes of the Object resource

    **Request Syntax** 

    ::

      object.load()
    :returns: None

  .. py:method:: put(**kwargs)

    Adds an object to a bucket.

    **Request Syntax** 
    ::

      response = object.put(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          Body=b'bytes',
          CacheControl='string',
          ContentDisposition='string',
          ContentEncoding='string',
          ContentLanguage='string',
          ContentLength=123,
          ContentMD5='string',
          ContentType='string',
          Expires=datetime(2015, 1, 1),
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWriteACP='string',
          Metadata={
              'string': 'string'
          },
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type Body: bytes
    :param Body: Object data.

    
    :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 ContentLength: integer
    :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    
    :type ContentMD5: string
    :param ContentMD5: 

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Expiration': 'string',
            'ETag': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'VersionId': 'string',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **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 for the uploaded object.
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **VersionId** *(string) --* Version of the object.
        

        - **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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.head_object` to update the attributes of the Object resource

    **Request Syntax** 

    ::

      object.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Acl()

    Creates a ObjectAcl resource.::

      object_acl = object.Acl()

    
    :rtype: :py:class:`S3.ObjectAcl`
    :returns: A ObjectAcl resource
    

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = object.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

  .. py:method:: MultipartUpload(id)

    Creates a MultipartUpload resource.::

      multipart_upload = object.MultipartUpload('id')

    :type id: string
    :param id: The MultipartUpload's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.MultipartUpload`
    :returns: A MultipartUpload resource
    

  .. py:method:: Version(id)

    Creates a ObjectVersion resource.::

      object_version = object.Version('id')

    :type id: string
    :param id: The Version's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.ObjectVersion`
    :returns: A ObjectVersion resource
    
  .. rst-class:: admonition-title
  
  Waiters
  
  Waiters provide an interface to wait for a resource to reach a specific state.
  For more information about waiters refer to the :ref:`Resources Introduction Guide<waiters_intro>`.
  

  .. py:method:: wait_until_exists(**kwargs)

    Waits until this Object is exists. This method calls :py:meth:`S3.Waiter.object_exists.wait` which polls. :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      object.wait_until_exists(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: wait_until_not_exists(**kwargs)

    Waits until this Object is not exists. This method calls :py:meth:`S3.Waiter.object_not_exists.wait` which polls. :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      object.wait_until_not_exists(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

=========
ObjectAcl
=========



.. py:class:: S3.ObjectAcl(bucket_name,object_key)

  A resource representing an Amazon Simple Storage Service (S3) ObjectAcl::

    
    import boto3
    
    s3 = boto3.resource('s3')
    object_acl = s3.ObjectAcl('bucket_name','object_key')

  :type bucket_name: string
  :param bucket_name: The ObjectAcl's bucket_name identifier. This **must** be set.
  :type object_key: string
  :param object_key: The ObjectAcl's object_key identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`object_key`

  
  These are the resource's available attributes:
  
  *   :py:attr:`owner`

  
  *   :py:attr:`request_charged`

  
  *   :py:attr:`grants`

  
  These are the resource's available actions:
  
  *   :py:meth:`load()`

  
  *   :py:meth:`put()`

  
  *   :py:meth:`reload()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Object()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The ObjectAcl's bucket_name identifier. This **must** be set.

  .. py:attribute:: object_key

    *(string)* The ObjectAcl's object_key identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: owner

    *(dict)* 

  .. py:attribute:: request_charged

    *(string)* If present, indicates that the requester was successfully charged for the request.

  .. py:attribute:: grants

    *(list)* A list of grants.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: load()

    Calls :py:meth:`s3.Client.get_object_acl` to update the attributes of the ObjectAcl resource

    **Request Syntax** 

    ::

      object_acl.load()
    :returns: None

  .. py:method:: put(**kwargs)

    uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

    **Request Syntax** 
    ::

      response = object_acl.put(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          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'
              }
          },
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWrite='string',
          GrantWriteACP='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type AccessControlPolicy: dict
    :param AccessControlPolicy: 

    
      - **Grants** *(list) --* A list of grants.

      
        - *(dict) --* 

        
          - **Grantee** *(dict) --* 

          
            - **DisplayName** *(string) --* Screen name of the grantee.

            
            - **EmailAddress** *(string) --* Email address of the grantee.

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

      
        - **DisplayName** *(string) --* 

        
        - **ID** *(string) --* 

        
      
    
    :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, overwrite, and delete any object in the bucket.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable bucket.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: reload()

    Calls :py:meth:`s3.Client.get_object_acl` to update the attributes of the ObjectAcl resource

    **Request Syntax** 

    ::

      object_acl.reload()
    :returns: None
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Object()

    Creates a Object resource.::

      object = object_acl.Object()

    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    

=============
ObjectSummary
=============



.. py:class:: S3.ObjectSummary(bucket_name,key)

  A resource representing an Amazon Simple Storage Service (S3) ObjectSummary::

    
    import boto3
    
    s3 = boto3.resource('s3')
    object_summary = s3.ObjectSummary('bucket_name','key')

  :type bucket_name: string
  :param bucket_name: The ObjectSummary's bucket_name identifier. This **must** be set.
  :type key: string
  :param key: The ObjectSummary's key identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`key`

  
  These are the resource's available attributes:
  
  *   :py:attr:`owner`

  
  *   :py:attr:`last_modified`

  
  *   :py:attr:`e_tag`

  
  *   :py:attr:`storage_class`

  
  *   :py:attr:`size`

  
  These are the resource's available actions:
  
  *   :py:meth:`copy_from()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`get()`

  
  *   :py:meth:`initiate_multipart_upload()`

  
  *   :py:meth:`put()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Acl()`

  
  *   :py:meth:`Bucket()`

  
  *   :py:meth:`MultipartUpload()`

  
  *   :py:meth:`Object()`

  
  *   :py:meth:`Version()`

  
  These are the resource's available waiters:
  
  *   :py:meth:`wait_until_exists()`

  
  *   :py:meth:`wait_until_not_exists()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The ObjectSummary's bucket_name identifier. This **must** be set.

  .. py:attribute:: key

    *(string)* The ObjectSummary's key identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: owner

    *(dict)* 

  .. py:attribute:: last_modified

    *(datetime)* 

  .. py:attribute:: e_tag

    *(string)* 

  .. py:attribute:: storage_class

    *(string)* The class of storage used to store the object.

  .. py:attribute:: size

    *(integer)* 
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: copy_from(**kwargs)

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

    **Request Syntax** 
    ::

      response = object_summary.copy_from(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          CacheControl='string',
          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',
          Metadata={
              'string': 'string'
          },
          MetadataDirective='COPY'|'REPLACE',
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          CopySourceSSECustomerAlgorithm='string',
          CopySourceSSECustomerKey='string',
          CopySourceSSECustomerKeyMD5='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :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 CopySource: string
    :param CopySource: **[REQUIRED]** The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable 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 ServerSideEncryption: string
    :param ServerSideEncryption: The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type CopySourceSSECustomerAlgorithm: string
    :param CopySourceSSECustomerAlgorithm: Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    
    :type CopySourceSSECustomerKey: string
    :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 the encryption key was transmitted without error.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CopyObjectResult': {
                'ETag': 'string',
                'LastModified': datetime(2015, 1, 1)
            },
            'Expiration': 'string',
            'CopySourceVersionId': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CopyObjectResult** *(dict) --* 
          

          - **ETag** *(string) --* 
          

          - **LastModified** *(datetime) --* 
      
        

        - **Expiration** *(string) --* If the object expiration is configured, the response includes this header.
        

        - **CopySourceVersionId** *(string) --* 
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: delete(**kwargs)

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

    **Request Syntax** 
    ::

      response = object_summary.delete(
          MFA='string',
          VersionId='string',
          RequestPayer='requester'
      )
    :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.

    
    :type VersionId: string
    :param VersionId: VersionId used to reference a specific version of the object.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'VersionId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

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

        - **VersionId** *(string) --* Returns the version ID of the delete marker created as a result of the DELETE operation.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: get(**kwargs)

    Retrieves objects from Amazon S3.

    **Request Syntax** 
    ::

      response = object_summary.get(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          ResponseCacheControl='string',
          ResponseContentDisposition='string',
          ResponseContentEncoding='string',
          ResponseContentLanguage='string',
          ResponseContentType='string',
          ResponseExpires=datetime(2015, 1, 1),
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Body': b'bytes',
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            'ETag': '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Body** *(bytes) --* 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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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.
        

        - **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 S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: initiate_multipart_upload(**kwargs)

    

    Initiates a multipart upload and returns an upload ID.

     

    **Note:** After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    

    **Request Syntax** 
    ::

      multipart_upload = object_summary.initiate_multipart_upload(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          CacheControl='string',
          ContentDisposition='string',
          ContentEncoding='string',
          ContentLanguage='string',
          ContentType='string',
          Expires=datetime(2015, 1, 1),
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWriteACP='string',
          Metadata={
              'string': 'string'
          },
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: :py:class:`s3.MultipartUpload`
    :returns: A MultipartUpload resource
    

  .. py:method:: put(**kwargs)

    Adds an object to a bucket.

    **Request Syntax** 
    ::

      response = object_summary.put(
          ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
          Body=b'bytes',
          CacheControl='string',
          ContentDisposition='string',
          ContentEncoding='string',
          ContentLanguage='string',
          ContentLength=123,
          ContentMD5='string',
          ContentType='string',
          Expires=datetime(2015, 1, 1),
          GrantFullControl='string',
          GrantRead='string',
          GrantReadACP='string',
          GrantWriteACP='string',
          Metadata={
              'string': 'string'
          },
          ServerSideEncryption='AES256'|'aws:kms',
          StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'LT',
          WebsiteRedirectLocation='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          SSEKMSKeyId='string',
          RequestPayer='requester'
      )
    :type ACL: string
    :param ACL: The canned ACL to apply to the object.

    
    :type Body: bytes
    :param Body: Object data.

    
    :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 ContentLength: integer
    :param ContentLength: Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    
    :type ContentMD5: string
    :param ContentMD5: 

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

    
    :type GrantRead: string
    :param GrantRead: Allows grantee to read the object data and its metadata.

    
    :type GrantReadACP: string
    :param GrantReadACP: Allows grantee to read the object ACL.

    
    :type GrantWriteACP: string
    :param GrantWriteACP: Allows grantee to write the ACL for the applicable object.

    
    :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 S3 (e.g., AES256, aws:kms).

    
    :type StorageClass: string
    :param StorageClass: The type of storage to use for the object. Defaults to 'STANDARD'.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type SSEKMSKeyId: string
    :param SSEKMSKeyId: Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Expiration': 'string',
            'ETag': 'string',
            'ServerSideEncryption': 'AES256'|'aws:kms',
            'VersionId': 'string',
            'SSECustomerAlgorithm': 'string',
            'SSECustomerKeyMD5': 'string',
            'SSEKMSKeyId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **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 for the uploaded object.
        

        - **ServerSideEncryption** *(string) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
        

        - **VersionId** *(string) --* Version of the object.
        

        - **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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Acl()

    Creates a ObjectAcl resource.::

      object_acl = object_summary.Acl()

    
    :rtype: :py:class:`S3.ObjectAcl`
    :returns: A ObjectAcl resource
    

  .. py:method:: Bucket()

    Creates a Bucket resource.::

      bucket = object_summary.Bucket()

    
    :rtype: :py:class:`S3.Bucket`
    :returns: A Bucket resource
    

  .. py:method:: MultipartUpload(id)

    Creates a MultipartUpload resource.::

      multipart_upload = object_summary.MultipartUpload('id')

    :type id: string
    :param id: The MultipartUpload's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.MultipartUpload`
    :returns: A MultipartUpload resource
    

  .. py:method:: Object()

    Creates a Object resource.::

      object = object_summary.Object()

    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    

  .. py:method:: Version(id)

    Creates a ObjectVersion resource.::

      object_version = object_summary.Version('id')

    :type id: string
    :param id: The Version's id identifier. This **must** be set.
    
    :rtype: :py:class:`S3.ObjectVersion`
    :returns: A ObjectVersion resource
    
  .. rst-class:: admonition-title
  
  Waiters
  
  Waiters provide an interface to wait for a resource to reach a specific state.
  For more information about waiters refer to the :ref:`Resources Introduction Guide<waiters_intro>`.
  

  .. py:method:: wait_until_exists(**kwargs)

    Waits until this ObjectSummary is exists. This method calls :py:meth:`S3.Waiter.object_exists.wait` which polls. :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      object_summary.wait_until_exists(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: wait_until_not_exists(**kwargs)

    Waits until this ObjectSummary is not exists. This method calls :py:meth:`S3.Waiter.object_not_exists.wait` which polls. :py:meth:`S3.Client.head_object` every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

    **Request Syntax** 
    ::

      object_summary.wait_until_not_exists(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          VersionId='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

=============
ObjectVersion
=============



.. py:class:: S3.ObjectVersion(bucket_name,object_key,id)

  A resource representing an Amazon Simple Storage Service (S3) ObjectVersion::

    
    import boto3
    
    s3 = boto3.resource('s3')
    object_version = s3.ObjectVersion('bucket_name','object_key','id')

  :type bucket_name: string
  :param bucket_name: The ObjectVersion's bucket_name identifier. This **must** be set.
  :type object_key: string
  :param object_key: The ObjectVersion's object_key identifier. This **must** be set.
  :type id: string
  :param id: The ObjectVersion's id identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`bucket_name`

  
  *   :py:attr:`object_key`

  
  *   :py:attr:`id`

  
  These are the resource's available attributes:
  
  *   :py:attr:`e_tag`

  
  *   :py:attr:`last_modified`

  
  *   :py:attr:`version_id`

  
  *   :py:attr:`storage_class`

  
  *   :py:attr:`key`

  
  *   :py:attr:`owner`

  
  *   :py:attr:`is_latest`

  
  *   :py:attr:`size`

  
  These are the resource's available actions:
  
  *   :py:meth:`delete()`

  
  *   :py:meth:`get()`

  
  *   :py:meth:`head()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Object()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: bucket_name

    *(string)* The ObjectVersion's bucket_name identifier. This **must** be set.

  .. py:attribute:: object_key

    *(string)* The ObjectVersion's object_key identifier. This **must** be set.

  .. py:attribute:: id

    *(string)* The ObjectVersion's id identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: e_tag

    *(string)* 

  .. py:attribute:: last_modified

    *(datetime)* Date and time the object was last modified.

  .. py:attribute:: version_id

    *(string)* Version ID of an object.

  .. py:attribute:: storage_class

    *(string)* The class of storage used to store the object.

  .. py:attribute:: key

    *(string)* The object key.

  .. py:attribute:: owner

    *(dict)* 

  .. py:attribute:: is_latest

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

  .. py:attribute:: size

    *(integer)* Size in bytes of the object.
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: delete(**kwargs)

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

    **Request Syntax** 
    ::

      response = object_version.delete(
          MFA='string',
          RequestPayer='requester'
      )
    :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.

    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'VersionId': 'string',
            'RequestCharged': 'requester'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

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

        - **VersionId** *(string) --* Returns the version ID of the delete marker created as a result of the DELETE operation.
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
    

  .. py:method:: get(**kwargs)

    Retrieves objects from Amazon S3.

    **Request Syntax** 
    ::

      response = object_version.get(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          ResponseCacheControl='string',
          ResponseContentDisposition='string',
          ResponseContentEncoding='string',
          ResponseContentLanguage='string',
          ResponseContentType='string',
          ResponseExpires=datetime(2015, 1, 1),
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :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 SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Body': b'bytes',
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            'ETag': '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Body** *(bytes) --* 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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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.
        

        - **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 S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    

  .. py:method:: head(**kwargs)

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

    **Request Syntax** 
    ::

      response = object_version.head(
          IfMatch='string',
          IfModifiedSince=datetime(2015, 1, 1),
          IfNoneMatch='string',
          IfUnmodifiedSince=datetime(2015, 1, 1),
          Range='string',
          SSECustomerAlgorithm='string',
          SSECustomerKey='string',
          RequestPayer='requester'
      )
    :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).

    
    :type IfModifiedSince: datetime
    :param IfModifiedSince: Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

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

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

    
    :type Range: string
    :param Range: Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    
    :type SSECustomerAlgorithm: string
    :param SSECustomerAlgorithm: Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    
    :type SSECustomerKey: string
    :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 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 the encryption key was transmitted without error.      Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required



    
    :type RequestPayer: string
    :param RequestPayer: Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeleteMarker': True|False,
            'AcceptRanges': 'string',
            'Expiration': 'string',
            'Restore': 'string',
            'LastModified': datetime(2015, 1, 1),
            'ContentLength': 123,
            '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',
            'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'LT',
            'RequestCharged': 'requester',
            'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'
        }
      **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) --* 
        

        - **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 operation and expiration time of the restored object copy.
        

        - **LastModified** *(datetime) --* Last modified date of the object
        

        - **ContentLength** *(integer) --* Size of the body in bytes.
        

        - **ETag** *(string) --* An 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) --* The Server-side encryption algorithm used when storing this object in S3 (e.g., 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 AWS Key Management Service (KMS) master encryption key that was used for the object.
        

        - **StorageClass** *(string) --* 
        

        - **RequestCharged** *(string) --* If present, indicates that the requester was successfully charged for the request.
        

        - **ReplicationStatus** *(string) --* 
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Object()

    Creates a Object resource.::

      object = object_version.Object()

    
    :rtype: :py:class:`S3.Object`
    :returns: A Object resource
    