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

Inherits:

Struct

Object
Struct
Aws::Backup::Types::DescribeBackupJobOutput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-backup/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#account_id ⇒ String

Returns the account ID that owns the backup job.
#backup_job_id ⇒ String

Uniquely identifies a request to Backup to back up a resource.
#backup_options ⇒ Hash<String,String>

Represents the options specified as part of backup plan or on-demand backup job.
#backup_size_in_bytes ⇒ Integer

The size, in bytes, of a backup (recovery point).
#backup_type ⇒ String

Represents the actual backup type selected for a backup job.
#backup_vault_arn ⇒ String

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

The name of a logical container where backups are stored.
#bytes_transferred ⇒ Integer

The size in bytes transferred to a backup vault at the time that the job status was queried.
#child_jobs_in_state ⇒ Hash<String,Integer>

This returns the statistics of the included child (nested) backup jobs.
#completion_date ⇒ Time

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
#created_by ⇒ Types::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.
#creation_date ⇒ Time

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).
#encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup.
#expected_completion_date ⇒ Time

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).
#iam_role_arn ⇒ String

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

The date a backup job was initiated.
#is_encrypted ⇒ Boolean

A boolean value indicating whether the backup is encrypted.
#is_parent ⇒ Boolean

This returns the boolean value that a backup job is a parent (composite) job.
#message_category ⇒ String

The job count for the specified message category.
#number_of_child_jobs ⇒ Integer

This returns the number of child (nested) backup jobs.
#parent_job_id ⇒ String

This returns the parent (composite) resource backup job ID.
#percent_done ⇒ String

Contains an estimated percentage that is complete of a job at the time the job status was queried.
#recovery_point_arn ⇒ 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`.
#recovery_point_lifecycle ⇒ Types::Lifecycle

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
#resource_arn ⇒ String

An ARN that uniquely identifies a saved resource.
#resource_name ⇒ String

The non-unique name of the resource that belongs to the specified backup.
#resource_type ⇒ 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.
#start_by ⇒ Time

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.
#state ⇒ String

The current state of a backup job.
#status_message ⇒ String

A detailed message explaining the status of the job to back up a resource.
#vault_lock_state ⇒ String

The lock state of the backup vault.
#vault_type ⇒ String

The type of backup vault where the recovery point is stored.

Instance Attribute Details

#account_id ⇒ `String`

Returns the account ID that owns the backup job.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_options ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_bytes ⇒ `Integer`

The size, in bytes, of a backup (recovery point).

This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of ‘0`, which may differ from the anticipated value.

The expected behavior for values by resource type are described as follows:

Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation ‘GetBackupJobStatus`.
For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
Amazon FSx does not populate this value from the operation ‘GetBackupJobStatus` for FSx file systems.
An Amazon RDS instance will show as ‘0`.
For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.

Returns:

(Integer)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_type ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_arn ⇒ `String`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_name ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_transferred ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_state ⇒ `Hash<String,Integer>`

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

Returns:

(Hash<String,Integer>)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_date ⇒ `Time`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_by ⇒ `Types::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.

Returns:

(Types::RecoveryPointCreator)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_date ⇒ `Time`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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

#encryption_key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_date ⇒ `Time`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_date ⇒ `Time`

The date a backup job was initiated.

Returns:

(Time)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_encrypted ⇒ `Boolean`

A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.

Returns:

(Boolean)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_parent ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_category ⇒ `String`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_jobs ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_done ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_arn ⇒ `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`.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_lifecycle ⇒ `Types::Lifecycle`

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can’t be changed after a backup has been transitioned to cold.

Resource types that can transition to cold storage are listed in the

Feature availability by resource][1: table. Backup ignores this

expression for other resource types.

To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for ‘MoveToColdStorageAfterDays` and `DeleteAfterDays`.

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource

Returns:

(Types::Lifecycle)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_type ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_by ⇒ `Time`

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)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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

#state ⇒ `String`

The current state of a backup job.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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_message ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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

#vault_lock_state ⇒ `String`

The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include ‘LOCKED` and `UNLOCKED`.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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

#vault_type ⇒ `String`

The type of backup vault where the recovery point is stored. Valid values are ‘BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults.

Returns:

(String)

# File 'lib/aws-sdk-backup/types.rb', line 3123

class DescribeBackupJobOutput < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :recovery_point_lifecycle,
  :backup_vault_arn,
  :vault_type,
  :vault_lock_state,
  :recovery_point_arn,
  :encryption_key_arn,
  :is_encrypted,
  :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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

#backup_job_id ⇒ String

#backup_options ⇒ Hash<String,String>

#backup_size_in_bytes ⇒ Integer

#backup_type ⇒ String

#backup_vault_arn ⇒ String

#backup_vault_name ⇒ String

#bytes_transferred ⇒ Integer

#child_jobs_in_state ⇒ Hash<String,Integer>

#completion_date ⇒ Time

#created_by ⇒ Types::RecoveryPointCreator

#creation_date ⇒ Time

#encryption_key_arn ⇒ String

#expected_completion_date ⇒ Time

#iam_role_arn ⇒ String

#initiation_date ⇒ Time

#is_encrypted ⇒ Boolean

#is_parent ⇒ Boolean

#message_category ⇒ String

#number_of_child_jobs ⇒ Integer

#parent_job_id ⇒ String

#percent_done ⇒ String

#recovery_point_arn ⇒ String

#recovery_point_lifecycle ⇒ Types::Lifecycle

#resource_arn ⇒ String

#resource_name ⇒ String

#resource_type ⇒ String

#start_by ⇒ Time

#state ⇒ String

#status_message ⇒ String

#vault_lock_state ⇒ String

#vault_type ⇒ String

#account_id ⇒ `String`

#backup_job_id ⇒ `String`

#backup_options ⇒ `Hash<String,String>`

#backup_size_in_bytes ⇒ `Integer`

#backup_type ⇒ `String`

#backup_vault_arn ⇒ `String`

#backup_vault_name ⇒ `String`

#bytes_transferred ⇒ `Integer`

#child_jobs_in_state ⇒ `Hash<String,Integer>`

#completion_date ⇒ `Time`

#created_by ⇒ `Types::RecoveryPointCreator`

#creation_date ⇒ `Time`

#encryption_key_arn ⇒ `String`

#expected_completion_date ⇒ `Time`

#iam_role_arn ⇒ `String`

#initiation_date ⇒ `Time`

#is_encrypted ⇒ `Boolean`

#is_parent ⇒ `Boolean`

#message_category ⇒ `String`

#number_of_child_jobs ⇒ `Integer`

#parent_job_id ⇒ `String`

#percent_done ⇒ `String`

#recovery_point_arn ⇒ `String`

#recovery_point_lifecycle ⇒ `Types::Lifecycle`

#resource_arn ⇒ `String`

#resource_name ⇒ `String`

#resource_type ⇒ `String`

#start_by ⇒ `Time`

#state ⇒ `String`

#status_message ⇒ `String`

#vault_lock_state ⇒ `String`

#vault_type ⇒ `String`