putObject method

Future<PutObjectOutput> putObject({
  1. required String bucket,
  2. required String key,
  3. ObjectCannedACL? acl,
  4. Uint8List? body,
  5. bool? bucketKeyEnabled,
  6. String? cacheControl,
  7. String? contentDisposition,
  8. String? contentEncoding,
  9. String? contentLanguage,
  10. int? contentLength,
  11. String? contentMD5,
  12. String? contentType,
  13. String? expectedBucketOwner,
  14. DateTime? expires,
  15. String? grantFullControl,
  16. String? grantRead,
  17. String? grantReadACP,
  18. String? grantWriteACP,
  19. Map<String, String>? metadata,
  20. ObjectLockLegalHoldStatus? objectLockLegalHoldStatus,
  21. ObjectLockMode? objectLockMode,
  22. DateTime? objectLockRetainUntilDate,
  23. RequestPayer? requestPayer,
  24. String? sSECustomerAlgorithm,
  25. Uint8List? sSECustomerKey,
  26. String? sSECustomerKeyMD5,
  27. String? sSEKMSEncryptionContext,
  28. String? sSEKMSKeyId,
  29. ServerSideEncryption? serverSideEncryption,
  30. StorageClass? storageClass,
  31. String? tagging,
  32. String? websiteRedirectLocation,
})

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

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. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

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, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value. Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption.

If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Versioning

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. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

Parameter bucket : The bucket name to which the PUT operation was initiated.

When using this API with an access point, 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 AWS 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 Simple Storage Service Developer Guide.

When using this API with Amazon 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 using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Parameter key : Object key for which the PUT operation was initiated.

Parameter acl : The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

Parameter body : Object data.

Parameter bucketKeyEnabled : Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT operation doesn’t affect bucket-level settings for S3 Bucket Key.

Parameter cacheControl : Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Parameter contentDisposition : Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Parameter contentEncoding : Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Parameter contentLanguage : The language the content is in.

Parameter contentLength : Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Parameter contentMD5 : The base64-encoded 128-bit MD5 digest 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.

Parameter contentType : A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

Parameter expectedBucketOwner : The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameter expires : The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Parameter grantFullControl : Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

Parameter grantRead : Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Parameter grantReadACP : Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Parameter grantWriteACP : Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Parameter metadata : A map of metadata to store with the object in S3.

Parameter objectLockLegalHoldStatus : Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Parameter objectLockMode : The Object Lock mode that you want to apply to this object.

Parameter objectLockRetainUntilDate : The date and time when you want this object's Object Lock to expire.

Parameter sSECustomerAlgorithm : Specifies the algorithm to use to when encrypting the object (for example, AES256).

Parameter sSECustomerKey : 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 x-amz-server-side-encryption-customer-algorithm header.

Parameter sSECustomerKeyMD5 : 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.

Parameter sSEKMSEncryptionContext : Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Parameter sSEKMSKeyId : If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Parameter serverSideEncryption : The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameter storageClass : 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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Parameter tagging : The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Parameter websiteRedirectLocation : 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 following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

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

Implementation

Future<PutObjectOutput> putObject({
  required String bucket,
  required String key,
  ObjectCannedACL? acl,
  Uint8List? body,
  bool? bucketKeyEnabled,
  String? cacheControl,
  String? contentDisposition,
  String? contentEncoding,
  String? contentLanguage,
  int? contentLength,
  String? contentMD5,
  String? contentType,
  String? expectedBucketOwner,
  DateTime? expires,
  String? grantFullControl,
  String? grantRead,
  String? grantReadACP,
  String? grantWriteACP,
  Map<String, String>? metadata,
  ObjectLockLegalHoldStatus? objectLockLegalHoldStatus,
  ObjectLockMode? objectLockMode,
  DateTime? objectLockRetainUntilDate,
  RequestPayer? requestPayer,
  String? sSECustomerAlgorithm,
  Uint8List? sSECustomerKey,
  String? sSECustomerKeyMD5,
  String? sSEKMSEncryptionContext,
  String? sSEKMSKeyId,
  ServerSideEncryption? serverSideEncryption,
  StorageClass? storageClass,
  String? tagging,
  String? websiteRedirectLocation,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(key, 'key');
  _s.validateStringLength(
    'key',
    key,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final headers = <String, String>{
    if (acl != null) 'x-amz-acl': acl.toValue(),
    if (bucketKeyEnabled != null)
      'x-amz-server-side-encryption-bucket-key-enabled':
          bucketKeyEnabled.toString(),
    if (cacheControl != null) 'Cache-Control': cacheControl.toString(),
    if (contentDisposition != null)
      'Content-Disposition': contentDisposition.toString(),
    if (contentEncoding != null)
      'Content-Encoding': contentEncoding.toString(),
    if (contentLanguage != null)
      'Content-Language': contentLanguage.toString(),
    if (contentLength != null) 'Content-Length': contentLength.toString(),
    if (contentMD5 != null) 'Content-MD5': contentMD5.toString(),
    if (contentType != null) 'Content-Type': contentType.toString(),
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
    if (expires != null) 'Expires': _s.rfc822ToJson(expires),
    if (grantFullControl != null)
      'x-amz-grant-full-control': grantFullControl.toString(),
    if (grantRead != null) 'x-amz-grant-read': grantRead.toString(),
    if (grantReadACP != null) 'x-amz-grant-read-acp': grantReadACP.toString(),
    if (grantWriteACP != null)
      'x-amz-grant-write-acp': grantWriteACP.toString(),
    if (metadata != null)
      ...metadata.map((key, value) => MapEntry('x-amz-meta-$key', value)),
    if (objectLockLegalHoldStatus != null)
      'x-amz-object-lock-legal-hold': objectLockLegalHoldStatus.toValue(),
    if (objectLockMode != null)
      'x-amz-object-lock-mode': objectLockMode.toValue(),
    if (objectLockRetainUntilDate != null)
      'x-amz-object-lock-retain-until-date':
          _s.iso8601ToJson(objectLockRetainUntilDate),
    if (requestPayer != null) 'x-amz-request-payer': requestPayer.toValue(),
    if (sSECustomerAlgorithm != null)
      'x-amz-server-side-encryption-customer-algorithm':
          sSECustomerAlgorithm.toString(),
    if (sSECustomerKey != null)
      'x-amz-server-side-encryption-customer-key': sSECustomerKey.toString(),
    if (sSECustomerKeyMD5 != null)
      'x-amz-server-side-encryption-customer-key-MD5':
          sSECustomerKeyMD5.toString(),
    if (sSEKMSEncryptionContext != null)
      'x-amz-server-side-encryption-context':
          sSEKMSEncryptionContext.toString(),
    if (sSEKMSKeyId != null)
      'x-amz-server-side-encryption-aws-kms-key-id': sSEKMSKeyId.toString(),
    if (serverSideEncryption != null)
      'x-amz-server-side-encryption': serverSideEncryption.toValue(),
    if (storageClass != null) 'x-amz-storage-class': storageClass.toValue(),
    if (tagging != null) 'x-amz-tagging': tagging.toString(),
    if (websiteRedirectLocation != null)
      'x-amz-website-redirect-location': websiteRedirectLocation.toString(),
  };
  final $result = await _protocol.sendRaw(
    method: 'PUT',
    requestUri:
        '/${Uri.encodeComponent(bucket)}/${key.split('/').map(Uri.encodeComponent).join('/')}',
    headers: headers,
    payload: body,
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return PutObjectOutput(
    bucketKeyEnabled: _s.extractHeaderBoolValue(
        $result.headers, 'x-amz-server-side-encryption-bucket-key-enabled'),
    eTag: _s.extractHeaderStringValue($result.headers, 'ETag'),
    expiration:
        _s.extractHeaderStringValue($result.headers, 'x-amz-expiration'),
    requestCharged: _s
        .extractHeaderStringValue($result.headers, 'x-amz-request-charged')
        ?.toRequestCharged(),
    sSECustomerAlgorithm: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-customer-algorithm'),
    sSECustomerKeyMD5: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-customer-key-MD5'),
    sSEKMSEncryptionContext: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-context'),
    sSEKMSKeyId: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-aws-kms-key-id'),
    serverSideEncryption: _s
        .extractHeaderStringValue(
            $result.headers, 'x-amz-server-side-encryption')
        ?.toServerSideEncryption(),
    versionId:
        _s.extractHeaderStringValue($result.headers, 'x-amz-version-id'),
  );
}