Interface Headers


  • public interface Headers
    Common S3 HTTP header values used throughout the AWS S3 Java client.
    • Field Detail

      • S3_ALTERNATE_DATE

        static final String S3_ALTERNATE_DATE
        Amazon's alternative date header: x-amz-date
        See Also:
        Constant Field Values
      • S3_USER_METADATA_PREFIX

        static final String S3_USER_METADATA_PREFIX
        Prefix for S3 user metadata: x-amz-meta-
        See Also:
        Constant Field Values
      • EXTENDED_REQUEST_ID

        static final String EXTENDED_REQUEST_ID
        S3 response header for a request's extended debugging ID
        See Also:
        Constant Field Values
      • CLOUD_FRONT_ID

        static final String CLOUD_FRONT_ID
        S3 response header in response from accelerate endpoint.
        See Also:
        Constant Field Values
      • METADATA_DIRECTIVE

        static final String METADATA_DIRECTIVE
        S3 request header indicating how to handle metadata when copying an object
        See Also:
        Constant Field Values
      • STORAGE_CLASS

        static final String STORAGE_CLASS
        Header describing what class of storage a user wants
        See Also:
        Constant Field Values
      • SERVER_SIDE_ENCRYPTION

        static final String SERVER_SIDE_ENCRYPTION
        Header for optional server-side encryption algorithm
        See Also:
        Constant Field Values
      • SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM

        static final String SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM
        Header for the encryption algorithm used when encrypting the object with customer-provided keys
        See Also:
        Constant Field Values
      • SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY

        static final String SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY
        Header for the customer-provided key for server-side encryption
        See Also:
        Constant Field Values
      • SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5

        static final String SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5
        Header for the MD5 digest of the customer-provided key for server-side encryption
        See Also:
        Constant Field Values
      • COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM

        static final String COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM
        Header for the encryption algorithm used when encrypting the object with customer-provided keys
        See Also:
        Constant Field Values
      • COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY

        static final String COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY
        Header for the customer-provided key for server-side encryption
        See Also:
        Constant Field Values
      • COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5

        static final String COPY_SOURCE_SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5
        Header for the MD5 digest of the customer-provided key for server-side encryption
        See Also:
        Constant Field Values
      • COPY_SOURCE_IF_MATCH

        static final String COPY_SOURCE_IF_MATCH
        ETag matching constraint header for the copy object request
        See Also:
        Constant Field Values
      • COPY_SOURCE_IF_NO_MATCH

        static final String COPY_SOURCE_IF_NO_MATCH
        ETag non-matching constraint header for the copy object request
        See Also:
        Constant Field Values
      • COPY_SOURCE_IF_UNMODIFIED_SINCE

        static final String COPY_SOURCE_IF_UNMODIFIED_SINCE
        Unmodified since constraint header for the copy object request
        See Also:
        Constant Field Values
      • COPY_SOURCE_IF_MODIFIED_SINCE

        static final String COPY_SOURCE_IF_MODIFIED_SINCE
        Modified since constraint header for the copy object request
        See Also:
        Constant Field Values
      • GET_OBJECT_IF_MODIFIED_SINCE

        static final String GET_OBJECT_IF_MODIFIED_SINCE
        Modified since constraint header for the get object request
        See Also:
        Constant Field Values
      • GET_OBJECT_IF_UNMODIFIED_SINCE

        static final String GET_OBJECT_IF_UNMODIFIED_SINCE
        Unmodified since constraint header for the get object request
        See Also:
        Constant Field Values
      • GET_OBJECT_IF_MATCH

        static final String GET_OBJECT_IF_MATCH
        ETag matching constraint header for the get object request
        See Also:
        Constant Field Values
      • GET_OBJECT_IF_NONE_MATCH

        static final String GET_OBJECT_IF_NONE_MATCH
        ETag non-matching constraint header for the get object request
        See Also:
        Constant Field Values
      • CRYPTO_KEY

        static final String CRYPTO_KEY
        Encrypted symmetric key header that is used in the Encryption Only (EO) envelope encryption mechanism.
        See Also:
        Constant Field Values
      • CRYPTO_KEY_V2

        static final String CRYPTO_KEY_V2
        Encrypted symmetric key header that is used in the Authenticated Encryption (AE) cryptographic module. Older versions of S3 encryption client with encryption-only capability would not be able to recognize this AE key, and therefore will be prevented from mistakenly decrypting ciphertext in AE format.
        See Also:
        Constant Field Values
      • CRYPTO_IV

        static final String CRYPTO_IV
        Initialization vector (IV) header that is used in the symmetric and envelope encryption mechanisms
        See Also:
        Constant Field Values
      • MATERIALS_DESCRIPTION

        static final String MATERIALS_DESCRIPTION
        JSON-encoded description of encryption materials used during encryption
        See Also:
        Constant Field Values
      • CRYPTO_INSTRUCTION_FILE

        static final String CRYPTO_INSTRUCTION_FILE
        Instruction file header to be placed in the metadata of instruction files
        See Also:
        Constant Field Values
      • UNENCRYPTED_CONTENT_LENGTH

        static final String UNENCRYPTED_CONTENT_LENGTH
        Header for the original, unencrypted size of an encrypted object
        See Also:
        Constant Field Values
      • UNENCRYPTED_CONTENT_MD5

        static final String UNENCRYPTED_CONTENT_MD5
        Header for the optional original unencrypted Content MD5 of an encrypted object
        See Also:
        Constant Field Values
      • REDIRECT_LOCATION

        static final String REDIRECT_LOCATION
        Header for optional redirect location of an object
        See Also:
        Constant Field Values
      • CRYPTO_KEYWRAP_ALGORITHM

        static final String CRYPTO_KEYWRAP_ALGORITHM
        Key wrapping algorithm such as "AESWrap" and "RSA/ECB/OAEPWithSHA-256AndMGF1Padding".
        See Also:
        Constant Field Values
      • CRYPTO_CEK_ALGORITHM

        static final String CRYPTO_CEK_ALGORITHM
        Content encryption algorithm, such as "AES/GCM/NoPadding".
        See Also:
        Constant Field Values
      • CRYPTO_TAG_LENGTH

        static final String CRYPTO_TAG_LENGTH
        Tag length applicable to authenticated encrypt/decryption.
        See Also:
        Constant Field Values
      • REQUESTER_PAYS_HEADER

        static final String REQUESTER_PAYS_HEADER
        Headers in request indicating that the requester must be charged for data transfer.
        See Also:
        Constant Field Values
      • REQUESTER_CHARGED_HEADER

        static final String REQUESTER_CHARGED_HEADER
        Header in the response indicating that the requester has been charged for the request.
        See Also:
        Constant Field Values
      • SERVER_SIDE_ENCRYPTION_AWS_KMS_KEYID

        static final String SERVER_SIDE_ENCRYPTION_AWS_KMS_KEYID
        Header in the request and response indicating the AWS Key Management System key id used for Server Side Encryption.
        See Also:
        Constant Field Values
      • OBJECT_REPLICATION_STATUS

        static final String OBJECT_REPLICATION_STATUS
        Header for the replication status of an Amazon S3 Object.
        See Also:
        Constant Field Values
      • S3_BUCKET_REGION

        static final String S3_BUCKET_REGION
        Region where the bucket is located. This header is returned only in HEAD bucket and ListObjects response.
        See Also:
        Constant Field Values
      • ABORT_DATE

        static final String ABORT_DATE
        Date when multipart upload will become eligible for abort operation by lifecycle.
        See Also:
        Constant Field Values
      • ABORT_RULE_ID

        static final String ABORT_RULE_ID
        Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
        See Also:
        Constant Field Values
      • S3_PARTS_COUNT

        static final String S3_PARTS_COUNT
        S3 response header for a multipart object containing the number of parts in the object.
        See Also:
        Constant Field Values