Class RestoreObjectRequest
Container for the parameters to the RestoreObject operation.
Restores an archived copy of an object back into Amazon S3
public class RestoreObjectRequest : AmazonWebServiceRequest- Inheritance
-
RestoreObjectRequest
Constructors
RestoreObjectRequest()
public RestoreObjectRequest()Properties
BucketName
The bucket name or containing the object to restore.
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.
public string BucketName { get; set; }Property Value
Days
Lifetime of the active copy in days ** Do not use with restores that specify OutputLocation **
public int Days { get; set; }Property Value
Description
The optional description for the job.
public string Description { get; set; }Property Value
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.
public string ExpectedBucketOwner { get; set; }Property Value
Key
Gets and sets the Key property. This key indicates the S3 object to restore.
public string Key { get; set; }Property Value
Remarks
This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri
OutputLocation
Describes the location where the restore job's output is stored.
public OutputLocation OutputLocation { get; set; }Property Value
RequestPayer
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
public RequestPayer RequestPayer { get; set; }Property Value
RestoreRequestType
Type of restore request.
public RestoreRequestType RestoreRequestType { get; set; }Property Value
RetrievalTier
Glacier retrieval tier at which the restore will be processed. ** Only use with restores that require OutputLocation **
public GlacierJobTier RetrievalTier { get; set; }Property Value
SelectParameters
Describes the parameters for Select job types.
public SelectParameters SelectParameters { get; set; }Property Value
Tier
Glacier retrieval tier at which the restore will be processed. ** Do not use with restores that specify OutputLocation **
public GlacierJobTier Tier { get; set; }Property Value
VersionId
VersionId used to reference a specific version of the object.
public string VersionId { get; set; }