Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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' {
- accountId :: Maybe Text
- backupSizeInBytes :: Maybe Integer
- completionDate :: Maybe POSIX
- createdResourceArn :: Maybe Text
- creationDate :: Maybe POSIX
- expectedCompletionTimeMinutes :: Maybe Integer
- iamRoleArn :: Maybe Text
- percentDone :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceType :: Maybe Text
- restoreJobId :: Maybe Text
- status :: Maybe RestoreJobStatus
- statusMessage :: Maybe Text
- httpStatus :: Int
}
newDescribeRestoreJobResponse :: Int -> DescribeRestoreJobResponse
describeRestoreJobResponse_accountId :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_backupSizeInBytes :: Lens' DescribeRestoreJobResponse (Maybe Integer)
describeRestoreJobResponse_completionDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime)
describeRestoreJobResponse_createdResourceArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_creationDate :: Lens' DescribeRestoreJobResponse (Maybe UTCTime)
describeRestoreJobResponse_expectedCompletionTimeMinutes :: Lens' DescribeRestoreJobResponse (Maybe Integer)
describeRestoreJobResponse_iamRoleArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_percentDone :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_recoveryPointArn :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_resourceType :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_restoreJobId :: Lens' DescribeRestoreJobResponse (Maybe Text)
describeRestoreJobResponse_status :: Lens' DescribeRestoreJobResponse (Maybe RestoreJobStatus)
describeRestoreJobResponse_statusMessage :: Lens' DescribeRestoreJobResponse (Maybe Text)
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

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 #
AWSRequest DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Associated Types type AWSResponse DescribeRestoreJob # Methods request :: (Service -> Service) -> DescribeRestoreJob -> Request DescribeRestoreJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRestoreJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRestoreJob))) #
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 #
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 #
NFData DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods rnf :: DescribeRestoreJob -> () #
Eq DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods (==) :: DescribeRestoreJob -> DescribeRestoreJob -> Bool # (/=) :: DescribeRestoreJob -> DescribeRestoreJob -> Bool #
Hashable DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods hashWithSalt :: Int -> DescribeRestoreJob -> Int # hash :: DescribeRestoreJob -> Int #
type AWSResponse DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type AWSResponse DescribeRestoreJob = DescribeRestoreJobResponse
type Rep DescribeRestoreJob Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type Rep DescribeRestoreJob = D1 ('MetaData "DescribeRestoreJob" "Amazonka.Backup.DescribeRestoreJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeRestoreJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restoreJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRestoreJob Source #

Arguments

:: Text	`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:

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

accountId :: Maybe Text
Returns the account ID that owns the restore job.
backupSizeInBytes :: Maybe Integer
The size, in bytes, of the restored resource.
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.
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.
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.
expectedCompletionTimeMinutes :: Maybe Integer
The amount of time in minutes that a job restoring a recovery point is expected to take.
iamRoleArn :: Maybe Text
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
percentDone :: Maybe Text
Contains an estimated percentage that is complete of a job at the time the job status was queried.
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.
resourceType :: Maybe Text
Returns metadata associated with a restore job listed by resource type.
restoreJobId :: Maybe Text
Uniquely identifies the job that restores a recovery point.
status :: Maybe RestoreJobStatus
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
statusMessage :: Maybe Text
A message showing the status of a job to restore a recovery point.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods rnf :: DescribeRestoreJobResponse -> () #
Eq DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob Methods (==) :: DescribeRestoreJobResponse -> DescribeRestoreJobResponse -> Bool # (/=) :: DescribeRestoreJobResponse -> DescribeRestoreJobResponse -> Bool #
type Rep DescribeRestoreJobResponse Source #
Instance details Defined in Amazonka.Backup.DescribeRestoreJob type Rep DescribeRestoreJobResponse = D1 ('MetaData "DescribeRestoreJobResponse" "Amazonka.Backup.DescribeRestoreJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeRestoreJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "backupSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "createdResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "expectedCompletionTimeMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "percentDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "restoreJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreJobStatus))) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

DescribeRestoreJobResponse, describeRestoreJobResponse_accountId - Returns the account ID that owns the restore job.

DescribeRestoreJobResponse, describeRestoreJobResponse_backupSizeInBytes - The size, in bytes, of the restored resource.

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.

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.

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.

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

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

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

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.

DescribeRestoreJobResponse, describeRestoreJobResponse_resourceType - Returns metadata associated with a restore job listed by resource type.

DescribeRestoreJob, describeRestoreJobResponse_restoreJobId - Uniquely identifies the job that restores a recovery point.

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

DescribeRestoreJobResponse, describeRestoreJobResponse_statusMessage - A message showing the status of a job to restore a recovery point.

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

Response Lenses

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

Returns the account ID that owns the restore job.

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

The size, in bytes, of the restored resource.

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_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_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_expectedCompletionTimeMinutes :: Lens' DescribeRestoreJobResponse (Maybe Integer) Source #

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

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_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_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_resourceType :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

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

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

Uniquely identifies the job that restores a recovery point.

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_statusMessage :: Lens' DescribeRestoreJobResponse (Maybe Text) Source #

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

describeRestoreJobResponse_httpStatus :: Lens' DescribeRestoreJobResponse Int Source #

The response's http status code.