Class: Aws::S3::Types::RestoreStatus

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#is_restore_in_progress ⇒ Boolean

Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="true"

If the object restoration has completed, the header returns the value FALSE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

If the object hasn't been restored, there is no header response.

Returns:

  • (Boolean) 


15321
15322
15323
15324
15325
15326
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15321

class RestoreStatus < Struct.new(
  :is_restore_in_progress,
  :restore_expiry_date)
  SENSITIVE = []
  include Aws::Structure
end

#restore_expiry_date ⇒ Time

Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

Returns:

  • (Time) 


15321
15322
15323
15324
15325
15326
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15321

class RestoreStatus < Struct.new(
  :is_restore_in_progress,
  :restore_expiry_date)
  SENSITIVE = []
  include Aws::Structure
end