End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
Adds an object to a bucket.
NotePutObject to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
412 Precondition Failed error. If a conflicting operation occurs during the upload, S3 returns a 409 ConditionalRequestConflict response. On a 409 failure, retry the upload. Expects the * character (asterisk). For more information, see Add preconditions to S3 operations with conditional requests in the Amazon S3 User Guide or RFC 7232 .This functionality is not supported for directory buckets.
Permissions
General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.
s3:PutObject ** - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.s3:PutObjectAcl ** - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl .s3:PutObjectTagging ** - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging .Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__ API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__ . If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
Data integrity with Content-MD5
General purpose bucket - To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the objectâs ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory bucket - This functionality is not supported for directory buckets.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is `` Bucket-name .s3express-zone-id .*region-code* .amazonaws.com`` .
For more information about related Amazon S3 APIs, see the following:
See also: AWS API Documentation
Synopsis¶put-object [--acl <value>] [--body <value>] --bucket <value> [--cache-control <value>] [--content-disposition <value>] [--content-encoding <value>] [--content-language <value>] [--content-length <value>] [--content-md5 <value>] [--content-type <value>] [--checksum-algorithm <value>] [--checksum-crc32 <value>] [--checksum-crc32-c <value>] [--checksum-crc64-nvme <value>] [--checksum-sha1 <value>] [--checksum-sha256 <value>] [--expires <value>] [--if-match <value>] [--if-none-match <value>] [--grant-full-control <value>] [--grant-read <value>] [--grant-read-acp <value>] [--grant-write-acp <value>] --key <value> [--write-offset-bytes <value>] [--metadata <value>] [--server-side-encryption <value>] [--storage-class <value>] [--website-redirect-location <value>] [--sse-customer-algorithm <value>] [--sse-customer-key <value>] [--sse-customer-key-md5 <value>] [--ssekms-key-id <value>] [--ssekms-encryption-context <value>] [--bucket-key-enabled | --no-bucket-key-enabled] [--request-payer <value>] [--tagging <value>] [--object-lock-mode <value>] [--object-lock-retain-until-date <value>] [--object-lock-legal-hold-status <value>] [--expected-bucket-owner <value>] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]Options¶
--acl (string)
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide .
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide .
If the bucket that youâre uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that donât specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
Notebucket-owner-full-controlcanned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a400error with the error codeAccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide .
- This functionality is not supported for directory buckets.
- This functionality is not supported for Amazon S3 on Outposts.
Possible values:
privatepublic-readpublic-read-writeauthenticated-readaws-exec-readbucket-owner-readbucket-owner-full-control
--body (streaming blob)
Object data.
NoteThis argument is of type: streaming blob. Its value must be the path to a file (e.g.path/to/file) and must not be prefixed withfile://orfileb://
--bucket (string)
The bucket name to which the PUT action was initiated.
NoteDirectory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format `` Bucket-name .s3express-zone-id .*region-code* .amazonaws.com`` . Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format `` bucket-base-name âzone-id âx-s3`` (for example, `` amzn-s3-demo-bucket âusw2-az1 âx-s3`` ). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide .
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 action 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 Using access points in the Amazon S3 User Guide .
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form `` AccessPointName -AccountId .*outpostID* .s3-outposts.*Region* .amazonaws.com`` . When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide .
--cache-control (string)
--content-disposition (string)
--content-encoding (string)
--content-language (string)
The language the content is in.
--content-length (long)
--content-md5 (string)
The Base64 encoded 128-bit
NoteMD5digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication .The
Content-MD5or
x-amz-sdk-checksum-algorithmheader is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
Uploading objects to an Object Lock enabled bucketin the
Amazon S3 User Guide.
NoteThis functionality is not supported for directory buckets.
--content-type (string)
--checksum-algorithm (string)
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-*algorithm* `` or ``x-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request.For the ``x-amz-checksum-algorithm `` header, replace `` algorithm `` with the supported algorithm from the following list:
CRC32CRC32CCRC64NVMESHA1SHA256For more information, see Checking object integrity in the Amazon S3 User Guide .
If the individual checksum value you provide through
Notex-amz-checksum-*algorithm* `` doesn't match the checksum algorithm you set through ``x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with aBadDigesterror.The
Content-MD5or
x-amz-sdk-checksum-algorithmheader is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
Uploading objects to an Object Lock enabled bucketin the
Amazon S3 User Guide.
For directory buckets, when you use Amazon Web Services SDKs,
CRC32is the default checksum algorithm thatâs used for performance.Possible values:
CRC32CRC32CSHA1SHA256CRC64NVME
--checksum-crc32 (string)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit
CRC32checksum of the object. For more information, see
Checking object integrityin the
Amazon S3 User Guide.
--checksum-crc32-c (string)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit
CRC32Cchecksum of the object. For more information, see
Checking object integrityin the
Amazon S3 User Guide.
--checksum-crc64-nvme (string)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit
CRC64NVMEchecksum of the object. The
CRC64NVMEchecksum is always a full object checksum. For more information, see
Checking object integrity in the Amazon S3 User Guide.
--checksum-sha1 (string)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit
SHA1digest of the object. For more information, see
Checking object integrityin the
Amazon S3 User Guide.
--checksum-sha256 (string)
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit
SHA256digest of the object. For more information, see
Checking object integrityin the
Amazon S3 User Guide.
--expires (timestamp)
--if-match (string)
Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a
412 Precondition Failederror.If a conflicting operation occurs during the upload S3 returns a
409 ConditionalRequestConflictresponse. On a 409 failure you should fetch the objectâs ETag and retry the upload.Expects the ETag value as a string.
For more information about conditional requests, see RFC 7232 , or Conditional requests in the Amazon S3 User Guide .
--if-none-match (string)
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a
412 Precondition Failederror.If a conflicting operation occurs during the upload S3 returns a
409 ConditionalRequestConflictresponse. On a 409 failure you should retry the upload.Expects the â*â (asterisk) character.
For more information about conditional requests, see RFC 7232 , or Conditional requests in the Amazon S3 User Guide .
--grant-full-control (string)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
Note
- This functionality is not supported for directory buckets.
- This functionality is not supported for Amazon S3 on Outposts.
--grant-read (string)
Allows grantee to read the object data and its metadata.
Note
- This functionality is not supported for directory buckets.
- This functionality is not supported for Amazon S3 on Outposts.
--grant-read-acp (string)
Allows grantee to read the object ACL.
Note
- This functionality is not supported for directory buckets.
- This functionality is not supported for Amazon S3 on Outposts.
--grant-write-acp (string)
Allows grantee to write the ACL for the applicable object.
Note
- This functionality is not supported for directory buckets.
- This functionality is not supported for Amazon S3 on Outposts.
--key (string)
Object key for which the PUT action was initiated.
--write-offset-bytes (long)
Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.
NoteThis functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
--metadata (map)
A map of metadata to store with the object in S3.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
--server-side-encryption (string)
The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.
Note
- General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide .
- Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucketâs default encryption uses the desired encryption configuration and you donât override the bucket default encryption in yourCreateSessionrequests orPUTobject requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide . For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads . In the Zonal endpoint API calls (except CopyObject and UploadPartCopy ) using the REST API, the encryption request headers must match the encryption settings that are specified in theCreateSessionrequest. You canât override the values of the encryption settings (x-amz-server-side-encryption,x-amz-server-side-encryption-aws-kms-key-id,x-amz-server-side-encryption-context, andx-amz-server-side-encryption-bucket-key-enabled) that are specified in theCreateSessionrequest. You donât need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from theCreateSessionrequest to protect new objects in the directory bucket.When you use the CLI or the Amazon Web Services SDKs, for
CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucketâs default encryption configuration for the
CreateSessionrequest. Itâs not supported to override the encryption settings values in the
CreateSessionrequest. So in the Zonal endpoint API calls (except
CopyObjectand
UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
- S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is
aws:fsx. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.Possible values:
AES256aws:fsxaws:kmsaws:kms:dsse
--storage-class (string)
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide .
Note
- Directory buckets only support
EXPRESS_ONEZONE(the S3 Express One Zone storage class) in Availability Zones andONEZONE_IA(the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.- Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
Possible values:
STANDARDREDUCED_REDUNDANCYSTANDARD_IAONEZONE_IAINTELLIGENT_TIERINGGLACIERDEEP_ARCHIVEOUTPOSTSGLACIER_IRSNOWEXPRESS_ONEZONEFSX_OPENZFS
--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. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide .
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.htmlIn the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects in the Amazon S3 User Guide .
NoteThis functionality is not supported for directory buckets.
--sse-customer-algorithm (string)
Specifies the algorithm to use when encrypting the object (for example,
NoteThis functionality is not supported for directory buckets.AES256).
--sse-customer-key (string)
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 S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
NoteThis functionality is not supported for directory buckets.x-amz-server-side-encryption-customer-algorithmheader.
--sse-customer-key-md5 (string)
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 that the encryption key was transmitted without error.
NoteThis functionality is not supported for directory buckets.
--ssekms-key-id (string)
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesnât exist in the same account thatâs issuing the command, you must use the full Key ARN not the Key ID.
General purpose buckets - If you specify
x-amz-server-side-encryptionwithaws:kmsoraws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specifyx-amz-server-side-encryption:aws:kmsorx-amz-server-side-encryption:aws:kms:dsse, but do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.Directory buckets - To encrypt data using SSE-KMS, itâs recommended to specify the
x-amz-server-side-encryptionheader toaws:kms. Then, thex-amz-server-side-encryption-aws-kms-key-idheader implicitly uses the bucketâs default KMS customer managed key ID. If you want to explicitly set thex-amz-server-side-encryption-aws-kms-key-idheader, it must match the bucketâs default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucketâs lifetime. The Amazon Web Services managed key (aws/s3) isnât supported. Incorrect key specification results in an HTTP400 Bad Requesterror.
--ssekms-encryption-context (string)
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObjectoperations on this object.General purpose buckets - This value must be explicitly added during
CopyObjectoperations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide .Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
--bucket-key-enabled | --no-bucket-key-enabled (boolean)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).
General purpose buckets - Setting this header to
truecauses Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesnât affect bucket-level settings for S3 Bucket Key.Directory buckets - S3 Bucket Keys are always enabled for
GETandPUToperations in a directory bucket and canât be disabled. S3 Bucket Keys arenât supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject , UploadPartCopy , the Copy operation in Batch Operations , or the import jobs . In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
--request-payer (string)
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 corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .
NoteThis functionality is not supported for directory buckets.Possible values:
requester
--tagging (string)
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, âKey1=Value1â)
NoteThis functionality is not supported for directory buckets.
--object-lock-mode (string)
The Object Lock mode that you want to apply to this object.
NoteThis functionality is not supported for directory buckets.Possible values:
GOVERNANCECOMPLIANCE
--object-lock-retain-until-date (timestamp)
The date and time when you want this objectâs Object Lock to expire. Must be formatted as a timestamp parameter.
NoteThis functionality is not supported for directory buckets.
--object-lock-legal-hold-status (string)
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide .
NoteThis functionality is not supported for directory buckets.Possible values:
ONOFF
--expected-bucket-owner (string)
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).
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override commandâs default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶Expiration -> (string)
If the expiration is configured for the object (see PutBucketLifecycleConfiguration ) in the Amazon S3 User Guide , the response includes this header. It includes the
NoteObject expiration information is not returned in directory buckets and this header returns the value âexpiry-dateandrule-idkey-value pairs that provide information about object expiration. The value of therule-idis URL-encoded.NotImplementedâ in all responses for directory buckets.
ETag -> (string)
Entity tag for the uploaded object.
General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory buckets - The ETag for the object in a directory bucket isnât the MD5 digest of the object.
ChecksumCRC32 -> (string)
The Base64 encoded, 32-bit
CRC32 checksumof the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, itâs a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see
Checking object integrityin the
Amazon S3 User Guide.
ChecksumCRC32C -> (string)
The Base64 encoded, 32-bit
CRC32Cchecksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, itâs a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see
Checking object integrityin the
Amazon S3 User Guide.
ChecksumCRC64NVME -> (string)
The Base64 encoded, 64-bit
CRC64NVMEchecksum of the object. This header is present if the object was uploaded with the
CRC64NVMEchecksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum,
CRC64NVME, to the uploaded object). For more information about how checksums are calculated with multipart uploads, see
Checking object integrity in the Amazon S3 User Guide.
ChecksumSHA1 -> (string)
The Base64 encoded, 160-bit
SHA1digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, itâs a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see
Checking object integrityin the
Amazon S3 User Guide.
ChecksumSHA256 -> (string)
The Base64 encoded, 256-bit
SHA256digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, itâs a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see
Checking object integrityin the
Amazon S3 User Guide.
ChecksumType -> (string)
This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For
PutObjectuploads, the checksum type is always
FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see
Checking object integrityin the
Amazon S3 User Guide.
ServerSideEncryption -> (string)
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
NoteWhen accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option isaws:fsx.
VersionId -> (string)
Version ID of the object.
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide . For information about returning the versioning state of a bucket, see GetBucketVersioning .
NoteThis functionality is not supported for directory buckets.
SSECustomerAlgorithm -> (string)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm thatâs used.
NoteThis functionality is not supported for directory buckets.
SSECustomerKeyMD5 -> (string)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
NoteThis functionality is not supported for directory buckets.
SSEKMSKeyId -> (string)
If present, indicates the ID of the KMS key that was used for object encryption.
SSEKMSEncryptionContext -> (string)
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObjectoperations on this object.
BucketKeyEnabled -> (boolean)
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Size -> (long)
The size of the object in bytes. This value is only be present if you append to an object.
NoteThis functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
RequestCharged -> (string)
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4