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 |
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.
DescribeRestoreJob' | |
|
Instances
newDescribeRestoreJob Source #
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.
DescribeRestoreJobResponse' | |
|
Instances
newDescribeRestoreJobResponse Source #
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.