Backup / Client / describe_backup_job

describe_backup_job

Backup.Client.describe_backup_job(**kwargs)

Returns backup job details for the specified BackupJobId.

See also: AWS API Documentation

Request Syntax

response = client.describe_backup_job(
    BackupJobId='string'
)

Parameters:

BackupJobId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AccountId': 'string',
    'BackupJobId': 'string',
    'BackupVaultName': 'string',
    'BackupVaultArn': 'string',
    'RecoveryPointArn': 'string',
    'ResourceArn': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'CompletionDate': datetime(2015, 1, 1),
    'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
    'StatusMessage': 'string',
    'PercentDone': 'string',
    'BackupSizeInBytes': 123,
    'IamRoleArn': 'string',
    'CreatedBy': {
        'BackupPlanId': 'string',
        'BackupPlanArn': 'string',
        'BackupPlanVersion': 'string',
        'BackupRuleId': 'string'
    },
    'ResourceType': 'string',
    'BytesTransferred': 123,
    'ExpectedCompletionDate': datetime(2015, 1, 1),
    'StartBy': datetime(2015, 1, 1),
    'BackupOptions': {
        'string': 'string'
    },
    'BackupType': 'string',
    'ParentJobId': 'string',
    'IsParent': True|False,
    'NumberOfChildJobs': 123,
    'ChildJobsInState': {
        'string': 123
    },
    'ResourceName': 'string'
}

Response Structure

• (dict) –

  • AccountId (string) –

    Returns the account ID that owns the backup job.

  • BackupJobId (string) –

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

  • BackupVaultName (string) –

    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.

  • BackupVaultArn (string) –

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

  • RecoveryPointArn (string) –

    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) –

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

  • CreationDate (datetime) –

    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.

  • CompletionDate (datetime) –

    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.

  • State (string) –

    The current state of a resource recovery point.

  • StatusMessage (string) –

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

  • PercentDone (string) –

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

  • BackupSizeInBytes (integer) –

    The size, in bytes, of a backup.

  • IamRoleArn (string) –

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

  • CreatedBy (dict) –

    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.

    • BackupPlanId (string) –

      Uniquely identifies a backup plan.

    • BackupPlanArn (string) –

      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

    • BackupPlanVersion (string) –

      Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

    • BackupRuleId (string) –

      Uniquely identifies a rule used to schedule the backup of a selection of resources.

  • ResourceType (string) –

    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.

  • BytesTransferred (integer) –

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

  • ExpectedCompletionDate (datetime) –

    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.

  • StartBy (datetime) –

    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.

  • BackupOptions (dict) –

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

    • (string) –

      • (string) –

  • BackupType (string) –

    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.

  • ParentJobId (string) –

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

  • IsParent (boolean) –

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

  • NumberOfChildJobs (integer) –

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

  • ChildJobsInState (dict) –

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

    • (string) –

      • (integer) –

  • ResourceName (string) –

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

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException

• Backup.Client.exceptions.DependencyFailureException