Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Backup.DescribeRestoreJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata associated with a restore job that is specified by a job ID.

Synopsis

data DescribeRestoreJob = DescribeRestoreJob' {
- restoreJobId :: Text
}
newDescribeRestoreJob :: Text -> DescribeRestoreJob
describeRestoreJob_restoreJobId :: Lens' DescribeRestoreJob Text
data DescribeRestoreJobResponse = DescribeRestoreJobResponse' {
- status :: Maybe RestoreJobStatus
- iamRoleArn :: Maybe Text
- expectedCompletionTimeMinutes :: Maybe Integer
- restoreJobId :: Maybe Text
- resourceType :: Maybe Text
- percentDone :: Maybe Text
- accountId :: Maybe Text
- createdResourceArn :: Maybe Text
- statusMessage :: Maybe Text
- recoveryPointArn :: Maybe Text
- backupSizeInBytes :: Maybe Integer
- creationDate :: Maybe POSIX
- completionDate :: Maybe POSIX
- httpStatus :: Int
}
newDescribeRestoreJobResponse :: Int -> DescribeRestoreJobResponse
describeRestoreJobResponse_status :: Lens' DescribeRestoreJobResponse (Maybe RestoreJobStatus)
describeRestoreJobResponse_iamRoleArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_expectedCompletionTimeMinutes :: Lens' DescribeRestoreJobResponse (Maybe Integer)
describeRestoreJobResponse_restoreJobId :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_resourceType :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_percentDone :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_accountId :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_createdResourceArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_statusMessage :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_recoveryPointArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_backupSizeInBytes :: Lens' DescribeRestoreJobResponse (Maybe Integer)
describeRestoreJobResponse_creationDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime)
describeRestoreJobResponse_completionDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime)
describeRestoreJobResponse_httpStatus :: Lens' DescribeRestoreJobResponse Int

Creating a Request

data DescribeRestoreJob Source #

See: newDescribeRestoreJob smart constructor.

Constructors

DescribeRestoreJob'
Fields restoreJobId :: Text Uniquely identifies the job that restores a recovery point.

Instances

Instances details

Eq DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods (==) :: DescribeRestoreJob -> DescribeRestoreJob -> Bool # (/=) :: DescribeRestoreJob -> DescribeRestoreJob -> Bool #
Read DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods readsPrec :: Int -> ReadS DescribeRestoreJob # readList :: ReadS [DescribeRestoreJob] # readPrec :: ReadPrec DescribeRestoreJob # readListPrec :: ReadPrec [DescribeRestoreJob] #
Show DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods showsPrec :: Int -> DescribeRestoreJob -> ShowS # show :: DescribeRestoreJob -> String # showList :: [DescribeRestoreJob] -> ShowS #
Generic DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Associated Types type Rep DescribeRestoreJob :: Type -> Type # Methods from :: DescribeRestoreJob -> Rep DescribeRestoreJob x # to :: Rep DescribeRestoreJob x -> DescribeRestoreJob #
NFData DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods rnf :: DescribeRestoreJob -> () #
Hashable DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods hashWithSalt :: Int -> DescribeRestoreJob -> Int # hash :: DescribeRestoreJob -> Int #
AWSRequest DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Associated Types type AWSResponse DescribeRestoreJob # Methods request :: DescribeRestoreJob -> Request DescribeRestoreJob # response :: MonadResource m => Logger -> Service -> Proxy DescribeRestoreJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRestoreJob))) #
ToHeaders DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods toHeaders :: DescribeRestoreJob -> [Header] #
ToPath DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods toPath :: DescribeRestoreJob -> ByteString #
ToQuery DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods toQuery :: DescribeRestoreJob -> QueryString #
type Rep DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type Rep DescribeRestoreJob = D1 ('MetaData "DescribeRestoreJob" "Amazonka.Backup.DescribeRestoreJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "DescribeRestoreJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restoreJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type AWSResponse DescribeRestoreJob = DescribeRestoreJobResponse

newDescribeRestoreJob Source #

Arguments

:: Text	`$sel:restoreJobId:DescribeRestoreJob'`
-> DescribeRestoreJob

Create a value of DescribeRestoreJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restoreJobId:DescribeRestoreJob', describeRestoreJob_restoreJobId - Uniquely identifies the job that restores a recovery point.

Request Lenses

describeRestoreJob_restoreJobId :: Lens' DescribeRestoreJob Text Source #

Uniquely identifies the job that restores a recovery point.

Destructuring the Response

data DescribeRestoreJobResponse Source #

See: newDescribeRestoreJobResponse smart constructor.

Constructors

DescribeRestoreJobResponse'

Fields

status :: Maybe RestoreJobStatus
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
iamRoleArn :: Maybe Text
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
expectedCompletionTimeMinutes :: Maybe Integer
The amount of time in minutes that a job restoring a recovery point is expected to take.
restoreJobId :: Maybe Text
Uniquely identifies the job that restores a recovery point.
resourceType :: Maybe Text
Returns metadata associated with a restore job listed by resource type.
percentDone :: Maybe Text
Contains an estimated percentage that is complete of a job at the time the job status was queried.
accountId :: Maybe Text
Returns the account ID that owns the restore job.
createdResourceArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
statusMessage :: Maybe Text
A message showing the status of a job to restore a recovery point.
recoveryPointArn :: Maybe Text
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
backupSizeInBytes :: Maybe Integer
The size, in bytes, of the restored resource.
creationDate :: Maybe POSIX
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
completionDate :: Maybe POSIX
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods (==) :: DescribeRestoreJobResponse -> DescribeRestoreJobResponse -> Bool # (/=) :: DescribeRestoreJobResponse -> DescribeRestoreJobResponse -> Bool #
Read DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods readsPrec :: Int -> ReadS DescribeRestoreJobResponse # readList :: ReadS [DescribeRestoreJobResponse] # readPrec :: ReadPrec DescribeRestoreJobResponse # readListPrec :: ReadPrec [DescribeRestoreJobResponse] #
Show DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods showsPrec :: Int -> DescribeRestoreJobResponse -> ShowS # show :: DescribeRestoreJobResponse -> String # showList :: [DescribeRestoreJobResponse] -> ShowS #
Generic DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Associated Types type Rep DescribeRestoreJobResponse :: Type -> Type # Methods from :: DescribeRestoreJobResponse -> Rep DescribeRestoreJobResponse x # to :: Rep DescribeRestoreJobResponse x -> DescribeRestoreJobResponse #
NFData DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods rnf :: DescribeRestoreJobResponse -> () #
type Rep DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type Rep DescribeRestoreJobResponse = D1 ('MetaData "DescribeRestoreJobResponse" "Amazonka.Backup.DescribeRestoreJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "DescribeRestoreJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreJobStatus)) :: (S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expectedCompletionTimeMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "restoreJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "percentDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "createdResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "backupSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeRestoreJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRestoreJobResponse'`
-> DescribeRestoreJobResponse

Create a value of DescribeRestoreJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DescribeRestoreJobResponse', describeRestoreJobResponse_status - Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

$sel:iamRoleArn:DescribeRestoreJobResponse', describeRestoreJobResponse_iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

$sel:expectedCompletionTimeMinutes:DescribeRestoreJobResponse', describeRestoreJobResponse_expectedCompletionTimeMinutes - The amount of time in minutes that a job restoring a recovery point is expected to take.

$sel:restoreJobId:DescribeRestoreJob', describeRestoreJobResponse_restoreJobId - Uniquely identifies the job that restores a recovery point.

$sel:resourceType:DescribeRestoreJobResponse', describeRestoreJobResponse_resourceType - Returns metadata associated with a restore job listed by resource type.

$sel:percentDone:DescribeRestoreJobResponse', describeRestoreJobResponse_percentDone - Contains an estimated percentage that is complete of a job at the time the job status was queried.

$sel:accountId:DescribeRestoreJobResponse', describeRestoreJobResponse_accountId - Returns the account ID that owns the restore job.

$sel:createdResourceArn:DescribeRestoreJobResponse', describeRestoreJobResponse_createdResourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

$sel:statusMessage:DescribeRestoreJobResponse', describeRestoreJobResponse_statusMessage - A message showing the status of a job to restore a recovery point.

$sel:recoveryPointArn:DescribeRestoreJobResponse', describeRestoreJobResponse_recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:backupSizeInBytes:DescribeRestoreJobResponse', describeRestoreJobResponse_backupSizeInBytes - The size, in bytes, of the restored resource.

$sel:creationDate:DescribeRestoreJobResponse', describeRestoreJobResponse_creationDate - The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:completionDate:DescribeRestoreJobResponse', describeRestoreJobResponse_completionDate - The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:httpStatus:DescribeRestoreJobResponse', describeRestoreJobResponse_httpStatus - The response's http status code.

Response Lenses

describeRestoreJobResponse_status :: Lens' DescribeRestoreJobResponse (Maybe RestoreJobStatus) Source #

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

describeRestoreJobResponse_iamRoleArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

describeRestoreJobResponse_expectedCompletionTimeMinutes :: Lens' DescribeRestoreJobResponse (Maybe Integer) Source #

The amount of time in minutes that a job restoring a recovery point is expected to take.

describeRestoreJobResponse_restoreJobId :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Uniquely identifies the job that restores a recovery point.

describeRestoreJobResponse_resourceType :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Returns metadata associated with a restore job listed by resource type.

describeRestoreJobResponse_percentDone :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Contains an estimated percentage that is complete of a job at the time the job status was queried.

describeRestoreJobResponse_accountId :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

Returns the account ID that owns the restore job.

describeRestoreJobResponse_createdResourceArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

describeRestoreJobResponse_statusMessage :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

A message showing the status of a job to restore a recovery point.

describeRestoreJobResponse_recoveryPointArn :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

describeRestoreJobResponse_backupSizeInBytes :: Lens' DescribeRestoreJobResponse (Maybe Integer) Source #

The size, in bytes, of the restored resource.

describeRestoreJobResponse_creationDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime) Source #

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRestoreJobResponse_completionDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime) Source #

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

describeRestoreJobResponse_httpStatus :: Lens' DescribeRestoreJobResponse Int Source #

The response's http status code.