Class UpdateObjectEncryptionRequest

    • Method Detail

      • bucket

        public final String bucket()

        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.

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

      • key

        public final String key()

        The key name of the object that you want to update the server-side encryption type for.

        Returns:
        The key name of the object that you want to update the server-side encryption type for.
      • versionId

        public final String versionId()

        The version ID of the object that you want to update the server-side encryption type for.

        Returns:
        The version ID of the object that you want to update the server-side encryption type for.
      • objectEncryption

        public final ObjectEncryption objectEncryption()

        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

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

      • requestPayer

        public final RequestPayer requestPayer()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer
      • requestPayerAsString

        public final String requestPayerAsString()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer
      • expectedBucketOwner

        public final String expectedBucketOwner()

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

        Returns:
        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).
      • contentMD5

        public final String 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.

        Returns:
        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.
      • checksumAlgorithm

        public final ChecksumAlgorithm checksumAlgorithm()

        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.

        If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

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

        See Also:
        ChecksumAlgorithm
      • checksumAlgorithmAsString

        public final String checksumAlgorithmAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

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

        See Also:
        ChecksumAlgorithm
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object