Class: Aws::Backup::Types::DescribeRestoreJobOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/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 restore job.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#backup_size_in_bytesInteger

The size, in bytes, of the restored resource.

Returns:

  • (Integer)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#completion_dateTime

The date and time that a job to restore a recovery point 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)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_byTypes::RestoreJobCreator

Contains identifying information about the creation of a restore job.



3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_resource_arnString

The Amazon Resource Name (ARN) of the resource that was created by the restore job.

The format of the ARN depends on the resource type of the backed-up resource.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The date and time that a restore 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)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_statusString

The status of the data generated by the restore test.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_status_messageString

This describes the restore job deletion status.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#expected_completion_time_minutesInteger

The amount of time in minutes that a job restoring a recovery point is expected to take.

Returns:

  • (Integer)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  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)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  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)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  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)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_creation_dateTime

The creation date of the recovery point made by the specifed restore job.

Returns:

  • (Time)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

Returns metadata associated with a restore job listed by resource type.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#restore_job_idString

Uniquely identifies the job that restores a recovery point.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

A message showing the status of a job to restore a recovery point.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#validation_statusString

The status of validation run on the indicated restore job.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#validation_status_messageString

The status message.

Returns:

  • (String)


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3418

class DescribeRestoreJobOutput < Struct.new(
  :account_id,
  :restore_job_id,
  :recovery_point_arn,
  :creation_date,
  :completion_date,
  :status,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :expected_completion_time_minutes,
  :created_resource_arn,
  :resource_type,
  :recovery_point_creation_date,
  :created_by,
  :validation_status,
  :validation_status_message,
  :deletion_status,
  :deletion_status_message)
  SENSITIVE = []
  include Aws::Structure
end