Read Object

Retrieve metadata of an object in AWS S3.

Note

Read Objects that were uploaded with SSE-C encryption keys must also be provided to the Read Object card otherwise a 400 bad request error is returned.

Options

Field Definition Type Required
Region Region for your AWS S3 bucket. Choose a region for your AWS S3 bucket. Dropdown TRUE

Input

Field Definition Type Required
Options
Bucket Bucket name of the bucket containing the object.> String TRUE
Key Key name of the object to read. String TRUE
Version ID Version Id used to reference a specific version of the object to read. If the version id is null enter the string value, null. String FALSE
Request Payer Confirms that the requester knows that they will be charged for the request. Dropdown FALSE
Expected Bucket Owner 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. String FALSE
Server Side Encryption Customer Algorithm Specifies the algorithm to use to when decrypting the object. String FALSE
Server Side Encryption Customer Key Specifies the customer-provided encryption key for AWS S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in SSE Customer Algorithm. String FALSE
Server Side Encryption Customer Key MD5 Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. String FALSE
If Match Read the object if its entity tag (ETag) matches the specified tag. String FALSE
If Modified Since Read the object if it has been modified since the specified time.

For example: Fri, 14 Jan 2022 23:34:36 GMT.

String FALSE
If Non Match Read the object if its entity tag (ETag) is different from the specified ETag. String FALSE
If Unmodified Since Read the object if it hasn't been modified since the specified time.

For example: Fri, 14 Jan 2022 23:34:36 GMT.

String FALSE

Output

Field Definition Type
Response    
Version ID Version ID of the object. String
Last Modified Last modified date of the object. String
ETag Opaque identifier assigned by a web server to a specific version of a resource found at a URL. String
Content Type Standard MIME type describing the format of the object data. String
Size Size of the object in bytes. Number
Archive Status Archive state of the head object. String
Delete Marker If True, specifies whether the object retrieved was a Delete Marker; otherwise, False. If false, this response header does not appear in the response. Boolean
Expiration If the object expiration is configured (PUT Bucket lifecycle), the response includes this value. String
Parts Count Count of parts this object contains. Number
Object Lock Legal Hold Specifies whether a legal hold is in effect for this object. This value is not returned if the specified version of this object has never had a legal hold applied. Boolean
Object Lock Mode Indicates whether this bucket has an Object Lock in effect for this object. String
Object Lock Retain Until Date Date and time when the Object Lock retention period expires. String
Replication Status AWS S3 returns this value if your request involves a bucket that is either a source or a destination in a replication rule. String
Request Charged If present, indicates that the requester was successfully charged for the request. String
Restore If the object is an archived object (an object whose storage class is GLACIER), the response includes this value if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored. If an archive copy is already restored, the value indicates when AWS S3 is scheduled to delete the object copy. If the object restoration is in progress, the header returns true. String
Server Side Encryption If the object is stored using server-side encryption either with an AWS KMS key or an AWS S3-managed encryption key, the response includes this value with the value of the server-side encryption algorithm used when storing this object in AWS S3. String
Server Side Encryption AWS KMS Key ID If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed key that was used for the object. String
Server Side Encryption Bucket Key Enabled Indicates whether the object uses an AWS S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). String
Server Side Encryption Customer Algorithm If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. String
Server Side Encryption Customer Key MD5 If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key. String
Storage Class Provides storage class information of the object. AWS S3 returns this header for all objects except for AWS S3 Standard storage class objects. String
Tagging Count Number of tags, if any, on the object. Number
Website Redirect Location 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. String

Related topics

AWS S3 connector

About the elements of Okta Workflows

AWS S3 Rest API overview