You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#backup_size_in_bytesInteger

The size, in bytes, of the restored resource.

Returns:

  • (Integer)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  include Aws::Structure
end

#created_resource_arnString

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

Returns:

  • (String)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  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)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  include Aws::Structure
end

#restore_job_idString

Uniquely identifies the job that restores a recovery point.

Returns:

  • (String)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  include Aws::Structure
end

#status_messageString

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

Returns:

  • (String)


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1598

class DescribeRestoreJobOutput < Struct.new(
  :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)
  include Aws::Structure
end