update_object_encryption¶
Operation¶
async
¶
update_object_encryption(input: UpdateObjectEncryptionInput, plugins: list[Plugin] | None = None) -> UpdateObjectEncryptionOutput
Note
This operation is not supported for directory buckets or Amazon S3 on Outposts buckets.
Updates the server-side encryption type of an existing encrypted object
in a general purpose bucket. You can use the UpdateObjectEncryption
operation to change encrypted objects from server-side encryption with
Amazon S3 managed keys (SSE-S3) to server-side encryption with Key
Management Service (KMS) keys (SSE-KMS), or to apply S3 Bucket Keys. You
can also use the UpdateObjectEncryption operation to change the
customer-managed KMS key used to encrypt your data so that you can
comply with custom key-rotation standards.
Using the UpdateObjectEncryption operation, you can atomically update
the server-side encryption type of an existing object in a general
purpose bucket without any data movement. The UpdateObjectEncryption
operation uses envelope encryption to re-encrypt the data key used to
encrypt and decrypt your object with your newly specified server-side
encryption type. In other words, when you use the
UpdateObjectEncryption operation, your data isn't copied, archived
objects in the S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive
storage classes aren't restored, and objects in the S3
Intelligent-Tiering storage class aren't moved between tiers.
Additionally, the UpdateObjectEncryption operation preserves all
object metadata properties, including the storage class, creation date,
last modified date, ETag, and checksum properties. For more information,
see Updating server-side encryption for existing
objects
in the Amazon S3 User Guide.
By default, all UpdateObjectEncryption requests that specify a
customer-managed KMS key are restricted to KMS keys that are owned by
the bucket owner's Amazon Web Services account. If you're using
Organizations, you can request the ability to use KMS keys owned by
other member accounts within your organization by contacting Amazon Web
Services Support.
Note
Source objects that are unencrypted, or encrypted with either dual-layer
server-side encryption with KMS keys (DSSE-KMS) or server-side
encryption with customer-provided keys (SSE-C) aren't supported by this
operation. Additionally, you cannot specify SSE-S3 encryption as the
requested new encryption type UpdateObjectEncryption request.
- Permissions
-
-
To use the
UpdateObjectEncryptionoperation, you must have the following permissions: -
s3:UpdateObjectEncryption -
kms:Encrypt -
kms:Decrypt -
kms:GenerateDataKey -
kms:ReEncrypt*
-
- If you're using Organizations, to use this operation with
customer-managed KMS keys from other Amazon Web Services accounts
within your organization, you must have the
organizations:DescribeAccountpermission.
- Errors
-
-
You might receive an
InvalidRequesterror for several reasons. Depending on the reason for the error, you might receive one of the following messages: -
The
UpdateObjectEncryptionoperation doesn't supported unencrypted source objects. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. -
The
UpdateObjectEncryptionoperation doesn't support source objects with the encryption type DSSE-KMS or SSE-C. Only source objects encrypted with SSE-S3 or SSE-KMS are supported. -
The
UpdateObjectEncryptionoperation doesn't support updating the encryption type to DSSE-KMS or SSE-C. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. -
Requests that modify an object encryption configuration require Amazon Web Services Signature Version 4. Modify the request to use Amazon Web Services Signature Version 4, and then try again.
-
Requests that modify an object encryption configuration require a valid new encryption type. Valid values are
SSEKMS. Modify the request to specify SSE-KMS for the updated encryption type, and then try again. -
Requests that modify an object's encryption type to SSE-KMS require an Amazon Web Services KMS key Amazon Resource Name (ARN). Modify the request to specify a KMS key ARN, and then try again.
-
Requests that modify an object's encryption type to SSE-KMS require a valid Amazon Web Services KMS key Amazon Resource Name (ARN). Confirm that you have a correctly formatted KMS key ARN in your request, and then try again.
-
The
BucketKeyEnabledvalue isn't valid. Valid values aretrueorfalse. Modify the request to specify a valid value, and then try again.
-
-
You might receive an
AccessDeniederror for several reasons. Depending on the reason for the error, you might receive one of the following messages:-
The Amazon Web Services KMS key in the request must be owned by the same account as the bucket. Modify the request to specify a KMS key from the same account, and then try again.
-
The bucket owner's account was approved to make
UpdateObjectEncryptionrequests that use any Amazon Web Services KMS key in their organization, but the bucket owner's account isn't part of an organization in Organizations. Make sure that the bucket owner's account and the specified KMS key belong to the same organization, and then try again. -
The specified Amazon Web Services KMS key must be from the same organization in Organizations as the bucket. Specify a KMS key that belongs to the same organization as the bucket, and then try again.
-
The encryption type for the specified object can't be updated because that object is protected by S3 Object Lock. If the object has a governance-mode retention period or a legal hold, you must first remove the Object Lock status on the object before you issue your
UpdateObjectEncryptionrequest. You can't use theUpdateObjectEncryptionoperation with objects that have an Object Lock compliance mode retention period applied to them.
-
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateObjectEncryptionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateObjectEncryptionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateObjectEncryptionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the general purpose bucket that contains the specified object key name.
When you use this operation with an access point attached to a general
purpose bucket, you must either provide the alias of the access point in
place of the bucket name or you must specify the access point Amazon
Resource Name (ARN). When using the access point ARN, you must direct
requests to the access point hostname. The access point hostname takes
the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
When using this operation with an access point through the Amazon Web
Services SDKs, you provide the access point ARN in place of the bucket
name. For more information about access point ARNs, see Referencing
access
points
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
Indicates the algorithm used to create the checksum for the object when
you use an Amazon Web Services SDK. This header doesn't 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
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
class-attribute
instance-attribute
¶
content_md5: str | None = ...
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.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide doesn't match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
class-attribute
instance-attribute
¶
key: str | None = ...
The key name of the object that you want to update the server-side encryption type for.
class-attribute
instance-attribute
¶
The updated server-side encryption type for this object. The
UpdateObjectEncryption operation supports the SSE-S3 and SSE-KMS
encryption types.
Valid Values: SSES3 | SSEKMS
class-attribute
instance-attribute
¶
request_payer: str | None = ...
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 in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateObjectEncryptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
request_charged: str | None = ...
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 in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.