AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RestoreObject operation.

Restores an archived copy of an object back into Amazon S3

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.RestoreObjectRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public class RestoreObjectRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The RestoreObjectRequest type exposes the following members

Constructors

NameDescription
Public Method RestoreObjectRequest()

Properties

NameTypeDescription
Public Property BucketName System.String

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

Public Property Days System.Int32

Lifetime of the active copy in days ** Do not use with restores that specify OutputLocation **

Public Property Description System.String

The optional description for the job.

Public Property ExpectedBucketOwner System.String

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 Property Key System.String

Gets and sets the Key property. This key indicates the S3 object to restore.

Public Property OutputLocation Amazon.S3.Model.OutputLocation

Describes the location where the restore job's output is stored.

Public Property RequestPayer Amazon.S3.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 Property RestoreRequestType Amazon.S3.RestoreRequestType

Type of restore request.

Public Property RetrievalTier Amazon.S3.GlacierJobTier

Glacier retrieval tier at which the restore will be processed. ** Only use with restores that require OutputLocation **

Public Property SelectParameters Amazon.S3.Model.SelectParameters

Describes the parameters for Select job types.

Public Property Tier Amazon.S3.GlacierJobTier

Glacier retrieval tier at which the restore will be processed. ** Do not use with restores that specify OutputLocation **

Public Property VersionId System.String

VersionId used to reference a specific version of the object.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5