S3 Put Object

S3 Put Object

API code: S3_PUT_OBJECT
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN | ANONYMOUS

Request
URI
PUT
https://apaas-29.eng.vmware.com//api/v1/s3/{bucketName}/{objectKey}
COPY
Path Parameters
bucketName
Required

The bucket name. It must be URL encoded.

objectKey
Required

The object key. It must be URL encoded.

Header Parameters
Cache-Control
Optional

Can be used to specify caching behavior along the request/reply chain.

Content-Disposition
Optional

Specifies presentational information for the object.

Content-Encoding
Optional

Specifies the content encodings that have been applied to the object and which decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Content-Language
Optional

The language that the content uses.

Content-Length
Optional

The size of the resource, in bytes.

Content-MD5
Optional

The base64-encoded 128-bit MD5 digest of the part data.

Content-Type
Optional

A standard MIME type that describes the format of the object data.

Expires
Optional

The date and time at which the object should no longer be cached.

x-amz-meta-*
Optional

Headers starting with x-amz-meta-* are user-defined metadata. Each one is sent and returned as a set of key-value pairs.

x-amz-tagging
Optional

Specifies a set of tags to associate with the object.

x-amz-acl
Optional

The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.

x-amz-grant-read
Optional

Allows the specified grantee(s) to list the objects in the bucket.

x-amz-grant-write
Optional

Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.

x-amz-grant-read-acp
Optional

Allows the specified grantee(s) to read the bucket ACL.

x-amz-grant-write-acp
Optional

Allows the specified grantee(s) to write the ACL for the applicable bucket.

x-amz-grant-full-control
Optional

Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.

x-amz-server-side-encryption
Optional

The server-side encryption algorithm for current object.

x-amz-server-side-encryption-customer-algorithm
Optional

The algorithm used during SSE-C encryption.

x-amz-server-side-encryption-customer-key
Optional

The 256-bit, base64-encoded key used to encrypt or decrypt data.

x-amz-server-side-encryption-customer-key-md5
Optional

The base64-encoded 128-bit MD5 digest of the encryption key.

x-amz-server-side-encryption-aws-kms-key-id
Optional

The ID of the Key Management Service that was used for the object.

x-amz-server-side-encryption-context
Optional

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.

x-amz-storage-class
Optional

Specifies the storage class the new resource will use. If not specified, OSE uses the default storage class.

x-amz-website-redirect-location
Optional

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.

x-amz-request-payer
Optional

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

x-amz-object-lock-legal-hold
Optional

Specifies whether a legal hold will be applied to this object.

x-amz-object-lock-mode
Optional

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

x-amz-object-lock-retain-until-date
Optional

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

string
!x-amz-copy-source
Optional

!x-amz-copy-source


Request Body
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Operation doesn't return any data structure

Response Headers

undefined
ETag

${api_response_header.etag}

undefined
x-amz-server-side-encryption-context

${api_response_header.kmsContext}

undefined
x-amz-expiration

${api_response_header.expiration}

undefined
x-amz-server-side-encryption-customer-key-md5

${api_response_header.customerKeyMD5}

undefined
x-amz-server-side-encryption-aws-kms-key-id

${api_response_header.kmsKeyId}

undefined
x-amz-server-side-encryption-customer-algorithm

${api_response_header.customerAlgorithm}

undefined
x-amz-server-side-encryption

${api_response_header.sse}

undefined
x-amz-request-charged

${api_response_header.requestCharged}

undefined
x-amz-version-id

${api_response_header.versionId}