DescribeBackupJobOutput

import type { DescribeBackupJobOutput } from "https://aws-api.deno.dev/v0.4/services/backup.ts?docs=full";

interface DescribeBackupJobOutput {

AccountId?: string | null;

BackupJobId?: string | null;

BackupOptions?: {

[key: string]: string | null | undefined;

} | null;

BackupSizeInBytes?: number | null;

BackupType?: string | null;

BackupVaultArn?: string | null;

BackupVaultName?: string | null;

BytesTransferred?: number | null;

ChildJobsInState?: [key in BackupJobState]: number | null | undefined | null;

CompletionDate?: Date | number | null;

CreatedBy?: RecoveryPointCreator | null;

CreationDate?: Date | number | null;

ExpectedCompletionDate?: Date | number | null;

IamRoleArn?: string | null;

IsParent?: boolean | null;

NumberOfChildJobs?: number | null;

ParentJobId?: string | null;

PercentDone?: string | null;

RecoveryPointArn?: string | null;

ResourceArn?: string | null;

ResourceName?: string | null;

ResourceType?: string | null;

StartBy?: Date | number | null;

State?: BackupJobState | null;

StatusMessage?: string | null;

}

§Properties

AccountId?: string | null

[src]

Returns the account ID that owns the backup job.

BackupJobId?: string | null

[src]

Uniquely identifies a request to Backup to back up a resource.

BackupOptions?: {

[key: string]: string | null | undefined;

} | null

[src]

Represents the options specified as part of backup plan or on-demand backup job.

BackupSizeInBytes?: number | null

[src]

The size, in bytes, of a backup.

BackupType?: string | null

[src]

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.

BackupVaultArn?: string | null

[src]

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName?: string | null

[src]

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.

BytesTransferred?: number | null

[src]

The size in bytes transferred to a backup vault at the time that the job status was queried.

ChildJobsInState?: [key in BackupJobState]: number | null | undefined | null

[src]

This returns the statistics of the included child (nested) backup jobs.

CompletionDate?: Date | number | null

[src]

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.

CreatedBy?: RecoveryPointCreator | null

[src]

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.

CreationDate?: Date | number | null

[src]

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.

ExpectedCompletionDate?: Date | number | null

[src]

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.

IamRoleArn?: string | null

[src]

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

IsParent?: boolean | null

[src]

This returns the boolean value that a backup job is a parent (composite) job.

NumberOfChildJobs?: number | null

[src]

This returns the number of child (nested) backup jobs.

ParentJobId?: string | null

[src]

This returns the parent (composite) resource backup job ID.

PercentDone?: string | null

[src]

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

RecoveryPointArn?: string | null

[src]

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

ResourceArn?: string | null

[src]

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

ResourceName?: string | null

[src]

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType?: string | null

[src]

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.

StartBy?: Date | number | null

[src]

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.

State?: BackupJobState | null

[src]

The current state of a resource recovery point.

StatusMessage?: string | null

[src]

A detailed message explaining the status of the job to back up a resource.