Class: Aws::Backup::Types::DescribeBackupJobOutput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-backup/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

Returns the account ID that owns the backup job.

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_job_idString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_optionsHash<String,String>

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

Returns:

  • (Hash<String,String>)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_size_in_bytesInteger

The size, in bytes, of a backup.

Returns:

  • (Integer)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_typeString

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.

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_arnString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_nameString

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.

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_transferredInteger

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

Returns:

  • (Integer)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#child_jobs_in_stateHash<String,Integer>

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

Returns:

  • (Hash<String,Integer>)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#completion_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.

Returns:

  • (Time)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#created_byTypes::RecoveryPointCreator

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.



2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#creation_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.

Returns:

  • (Time)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#expected_completion_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.

Returns:

  • (Time)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#initiation_dateTime

The date a backup job was initiated.

Returns:

  • (Time)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#is_parentBoolean

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

Returns:

  • (Boolean)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#message_categoryString

The job count for the specified message category.

Example strings may include ‘AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `INVALIDPARAMETERS`. View [Monitoring] for a list of accepted MessageCategory strings.

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_child_jobsInteger

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

Returns:

  • (Integer)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#parent_job_idString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#percent_doneString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arnString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_nameString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

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.

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#start_byTime

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.

Returns:

  • (Time)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The current state of a backup job.

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

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

Returns:

  • (String)


2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/aws-sdk-backup/types.rb', line 2590

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :resource_type,
  :bytes_transferred,
  :expected_completion_date,
  :start_by,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :initiation_date,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end