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 backup job details for the specified BackupJobId
.
Synopsis
- data DescribeBackupJob = DescribeBackupJob' {
- backupJobId :: Text
- newDescribeBackupJob :: Text -> DescribeBackupJob
- describeBackupJob_backupJobId :: Lens' DescribeBackupJob Text
- data DescribeBackupJobResponse = DescribeBackupJobResponse' {
- accountId :: Maybe Text
- backupJobId :: Maybe Text
- backupOptions :: Maybe (HashMap Text Text)
- backupSizeInBytes :: Maybe Integer
- backupType :: Maybe Text
- backupVaultArn :: Maybe Text
- backupVaultName :: Maybe Text
- bytesTransferred :: Maybe Integer
- childJobsInState :: Maybe (HashMap BackupJobState Integer)
- completionDate :: Maybe POSIX
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- expectedCompletionDate :: Maybe POSIX
- iamRoleArn :: Maybe Text
- isParent :: Maybe Bool
- numberOfChildJobs :: Maybe Integer
- parentJobId :: Maybe Text
- percentDone :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- startBy :: Maybe POSIX
- state :: Maybe BackupJobState
- statusMessage :: Maybe Text
- httpStatus :: Int
- newDescribeBackupJobResponse :: Int -> DescribeBackupJobResponse
- describeBackupJobResponse_accountId :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_backupJobId :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_backupOptions :: Lens' DescribeBackupJobResponse (Maybe (HashMap Text Text))
- describeBackupJobResponse_backupSizeInBytes :: Lens' DescribeBackupJobResponse (Maybe Integer)
- describeBackupJobResponse_backupType :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_backupVaultArn :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_backupVaultName :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_bytesTransferred :: Lens' DescribeBackupJobResponse (Maybe Integer)
- describeBackupJobResponse_childJobsInState :: Lens' DescribeBackupJobResponse (Maybe (HashMap BackupJobState Integer))
- describeBackupJobResponse_completionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime)
- describeBackupJobResponse_createdBy :: Lens' DescribeBackupJobResponse (Maybe RecoveryPointCreator)
- describeBackupJobResponse_creationDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime)
- describeBackupJobResponse_expectedCompletionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime)
- describeBackupJobResponse_iamRoleArn :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_isParent :: Lens' DescribeBackupJobResponse (Maybe Bool)
- describeBackupJobResponse_numberOfChildJobs :: Lens' DescribeBackupJobResponse (Maybe Integer)
- describeBackupJobResponse_parentJobId :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_percentDone :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_recoveryPointArn :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_resourceArn :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_resourceType :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_startBy :: Lens' DescribeBackupJobResponse (Maybe UTCTime)
- describeBackupJobResponse_state :: Lens' DescribeBackupJobResponse (Maybe BackupJobState)
- describeBackupJobResponse_statusMessage :: Lens' DescribeBackupJobResponse (Maybe Text)
- describeBackupJobResponse_httpStatus :: Lens' DescribeBackupJobResponse Int
Creating a Request
data DescribeBackupJob Source #
See: newDescribeBackupJob
smart constructor.
DescribeBackupJob' | |
|
Instances
Create a value of DescribeBackupJob
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:
DescribeBackupJob
, describeBackupJob_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
Request Lenses
describeBackupJob_backupJobId :: Lens' DescribeBackupJob Text Source #
Uniquely identifies a request to Backup to back up a resource.
Destructuring the Response
data DescribeBackupJobResponse Source #
See: newDescribeBackupJobResponse
smart constructor.
DescribeBackupJobResponse' | |
|
Instances
newDescribeBackupJobResponse Source #
Create a value of DescribeBackupJobResponse
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:
DescribeBackupJobResponse
, describeBackupJobResponse_accountId
- Returns the account ID that owns the backup job.
DescribeBackupJob
, describeBackupJobResponse_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
DescribeBackupJobResponse
, describeBackupJobResponse_backupOptions
- Represents the options specified as part of backup plan or on-demand
backup job.
DescribeBackupJobResponse
, describeBackupJobResponse_backupSizeInBytes
- The size, in bytes, of a backup.
DescribeBackupJobResponse
, describeBackupJobResponse_backupType
- Represents the actual backup type selected for a backup job. For
example, if a successful Windows Volume Shadow Copy Service (VSS) backup
was taken, BackupType
returns "WindowsVSS"
. If BackupType
is
empty, then the backup type was a regular backup.
DescribeBackupJobResponse
, describeBackupJobResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
DescribeBackupJobResponse
, describeBackupJobResponse_backupVaultName
- The name of a logical container where backups are stored. Backup vaults
are identified by names that are unique to the account used to create
them and the Amazon Web Services Region where they are created. They
consist of lowercase letters, numbers, and hyphens.
DescribeBackupJobResponse
, describeBackupJobResponse_bytesTransferred
- The size in bytes transferred to a backup vault at the time that the job
status was queried.
DescribeBackupJobResponse
, describeBackupJobResponse_childJobsInState
- This returns the statistics of the included child (nested) backup jobs.
DescribeBackupJobResponse
, describeBackupJobResponse_completionDate
- The date and time that a job to create a backup job 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.
DescribeBackupJobResponse
, describeBackupJobResponse_createdBy
- Contains identifying information about the creation of a backup job,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan that is used to create it.
DescribeBackupJobResponse
, describeBackupJobResponse_creationDate
- The date and time that a backup 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.
DescribeBackupJobResponse
, describeBackupJobResponse_expectedCompletionDate
- The date and time that a job to back up resources is expected to be
completed, in Unix format and Coordinated Universal Time (UTC). The
value of ExpectedCompletionDate
is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
DescribeBackupJobResponse
, describeBackupJobResponse_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
DescribeBackupJobResponse
, describeBackupJobResponse_isParent
- This returns the boolean value that a backup job is a parent (composite)
job.
DescribeBackupJobResponse
, describeBackupJobResponse_numberOfChildJobs
- This returns the number of child (nested) backup jobs.
DescribeBackupJobResponse
, describeBackupJobResponse_parentJobId
- This returns the parent (composite) resource backup job ID.
DescribeBackupJobResponse
, describeBackupJobResponse_percentDone
- Contains an estimated percentage that is complete of a job at the time
the job status was queried.
DescribeBackupJobResponse
, describeBackupJobResponse_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
.
DescribeBackupJobResponse
, describeBackupJobResponse_resourceArn
- An ARN that uniquely identifies a saved resource. The format of the ARN
depends on the resource type.
DescribeBackupJobResponse
, describeBackupJobResponse_resourceType
- The type of Amazon Web Services resource to be backed up; for example,
an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database.
DescribeBackupJobResponse
, describeBackupJobResponse_startBy
- Specifies the time in Unix format and Coordinated Universal Time (UTC)
when a backup job must be started before it is canceled. The value is
calculated by adding the start window to the scheduled time. So if the
scheduled time were 6:00 PM and the start window is 2 hours, the
StartBy
time would be 8:00 PM on the date specified. The value of
StartBy
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
DescribeBackupJobResponse
, describeBackupJobResponse_state
- The current state of a resource recovery point.
DescribeBackupJobResponse
, describeBackupJobResponse_statusMessage
- A detailed message explaining the status of the job to back up a
resource.
$sel:httpStatus:DescribeBackupJobResponse'
, describeBackupJobResponse_httpStatus
- The response's http status code.
Response Lenses
describeBackupJobResponse_accountId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
Returns the account ID that owns the backup job.
describeBackupJobResponse_backupJobId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
Uniquely identifies a request to Backup to back up a resource.
describeBackupJobResponse_backupOptions :: Lens' DescribeBackupJobResponse (Maybe (HashMap Text Text)) Source #
Represents the options specified as part of backup plan or on-demand backup job.
describeBackupJobResponse_backupSizeInBytes :: Lens' DescribeBackupJobResponse (Maybe Integer) Source #
The size, in bytes, of a backup.
describeBackupJobResponse_backupType :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
Represents the actual backup type selected for a backup job. For
example, if a successful Windows Volume Shadow Copy Service (VSS) backup
was taken, BackupType
returns "WindowsVSS"
. If BackupType
is
empty, then the backup type was a regular backup.
describeBackupJobResponse_backupVaultArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
describeBackupJobResponse_backupVaultName :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
describeBackupJobResponse_bytesTransferred :: Lens' DescribeBackupJobResponse (Maybe Integer) Source #
The size in bytes transferred to a backup vault at the time that the job status was queried.
describeBackupJobResponse_childJobsInState :: Lens' DescribeBackupJobResponse (Maybe (HashMap BackupJobState Integer)) Source #
This returns the statistics of the included child (nested) backup jobs.
describeBackupJobResponse_completionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #
The date and time that a job to create a backup job 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.
describeBackupJobResponse_createdBy :: Lens' DescribeBackupJobResponse (Maybe RecoveryPointCreator) Source #
Contains identifying information about the creation of a backup job,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan that is used to create it.
describeBackupJobResponse_creationDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #
The date and time that a backup 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.
describeBackupJobResponse_expectedCompletionDate :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #
The date and time that a job to back up resources is expected to be
completed, in Unix format and Coordinated Universal Time (UTC). The
value of ExpectedCompletionDate
is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
describeBackupJobResponse_iamRoleArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
describeBackupJobResponse_isParent :: Lens' DescribeBackupJobResponse (Maybe Bool) Source #
This returns the boolean value that a backup job is a parent (composite) job.
describeBackupJobResponse_numberOfChildJobs :: Lens' DescribeBackupJobResponse (Maybe Integer) Source #
This returns the number of child (nested) backup jobs.
describeBackupJobResponse_parentJobId :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
This returns the parent (composite) resource backup job ID.
describeBackupJobResponse_percentDone :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
Contains an estimated percentage that is complete of a job at the time the job status was queried.
describeBackupJobResponse_recoveryPointArn :: Lens' DescribeBackupJobResponse (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
.
describeBackupJobResponse_resourceArn :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
describeBackupJobResponse_resourceType :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
describeBackupJobResponse_startBy :: Lens' DescribeBackupJobResponse (Maybe UTCTime) Source #
Specifies the time in Unix format and Coordinated Universal Time (UTC)
when a backup job must be started before it is canceled. The value is
calculated by adding the start window to the scheduled time. So if the
scheduled time were 6:00 PM and the start window is 2 hours, the
StartBy
time would be 8:00 PM on the date specified. The value of
StartBy
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
describeBackupJobResponse_state :: Lens' DescribeBackupJobResponse (Maybe BackupJobState) Source #
The current state of a resource recovery point.
describeBackupJobResponse_statusMessage :: Lens' DescribeBackupJobResponse (Maybe Text) Source #
A detailed message explaining the status of the job to back up a resource.
describeBackupJobResponse_httpStatus :: Lens' DescribeBackupJobResponse Int Source #
The response's http status code.