:doc:`S3 <../../s3>` / Client / put_object_lock_configuration

*****************************
put_object_lock_configuration
*****************************



.. py:method:: S3.Client.put_object_lock_configuration(**kwargs)

  

  .. note::

    

    This operation is not supported for directory buckets.

    

   

  Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see `Locking Objects <https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html>`__.

   

  .. note::

    

    
    * The ``DefaultRetention`` settings require both a mode and a period.
     
    * The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.
     
    * You can enable Object Lock for new or existing buckets. For more information, see `Configuring Object Lock <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html>`__.
    

    

   

  .. warning::

     

    You must URL encode any signed header values that contain spaces. For example, if your header value is ``my file.txt``, containing two spaces after ``my``, you must URL encode this value to ``my%20%20file.txt``.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration>`_  


  **Request Syntax**
  ::

    response = client.put_object_lock_configuration(
        Bucket='string',
        ObjectLockConfiguration={
            'ObjectLockEnabled': 'Enabled',
            'Rule': {
                'DefaultRetention': {
                    'Mode': 'GOVERNANCE'|'COMPLIANCE',
                    'Days': 123,
                    'Years': 123
                }
            }
        },
        RequestPayer='requester',
        Token='string',
        ContentMD5='string',
        ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'|'CRC64NVME',
        ExpectedBucketOwner='string'
    )
    
  :type Bucket: string
  :param Bucket: **[REQUIRED]** 

    The bucket whose Object Lock configuration you want to create or replace.

    

  
  :type ObjectLockConfiguration: dict
  :param ObjectLockConfiguration: 

    The Object Lock configuration that you want to apply to the specified bucket.

    

  
    - **ObjectLockEnabled** *(string) --* 

      Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.

      

    
    - **Rule** *(dict) --* 

      Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket. Bucket settings require both a mode and a period. The period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.

      

    
      - **DefaultRetention** *(dict) --* 

        The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.

        

      
        - **Mode** *(string) --* 

          The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either ``Days`` or ``Years``.

          

        
        - **Days** *(integer) --* 

          The number of days that you want to specify for the default retention period. Must be used with ``Mode``.

          

        
        - **Years** *(integer) --* 

          The number of years that you want to specify for the default retention period. Must be used with ``Mode``.

          

        
      
    
  
  :type RequestPayer: string
  :param RequestPayer: 

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see `Downloading Objects in Requester Pays Buckets <https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html>`__ in the *Amazon S3 User Guide*.

     

    .. note::

      

      This functionality is not supported for directory buckets.

      

    

  
  :type Token: string
  :param Token: 

    A token to allow Object Lock to be enabled for an existing bucket.

    

  
  :type ContentMD5: string
  :param ContentMD5: 

    The MD5 hash for the request body.

     

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

    

  
  :type ChecksumAlgorithm: string
  :param ChecksumAlgorithm: 

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding ``x-amz-checksum`` or ``x-amz-trailer`` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code ``400 Bad Request``. For more information, see `Checking object integrity <https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html>`__ in the *Amazon S3 User Guide*.

     

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

    

  
  :type ExpectedBucketOwner: string
  :param ExpectedBucketOwner: 

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ``403 Forbidden`` (access denied).

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **RequestCharged** *(string) --* 

        If present, indicates that the requester was successfully charged for the request. For more information, see `Using Requester Pays buckets for storage transfers and usage <https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html>`__ in the *Amazon Simple Storage Service user guide*.

         

        .. note::

          

          This functionality is not supported for directory buckets.

          

        
  