AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backup ]

describe-restore-job

Description

Returns metadata associated with a restore job that is specified by a job ID.

See also: AWS API Documentation

Synopsis

  describe-restore-job
--restore-job-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--restore-job-id (string)

Uniquely identifies the job that restores a recovery point.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

AccountId -> (string)

Returns the account ID that owns the restore job.

RestoreJobId -> (string)

Uniquely identifies the job that restores a recovery point.

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 .

CreationDate -> (timestamp)

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.

CompletionDate -> (timestamp)

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.

Status -> (string)

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

StatusMessage -> (string)

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

PercentDone -> (string)

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

BackupSizeInBytes -> (long)

The size, in bytes, of the restored resource.

IamRoleArn -> (string)

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

ExpectedCompletionTimeMinutes -> (long)

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

CreatedResourceArn -> (string)

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.

ResourceType -> (string)

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

RecoveryPointCreationDate -> (timestamp)

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

CreatedBy -> (structure)

Contains identifying information about the creation of a restore job.

RestoreTestingPlanArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

ValidationStatus -> (string)

This is the status of validation run on the indicated restore job.

ValidationStatusMessage -> (string)

This describes the status of validation run on the indicated restore job.

DeletionStatus -> (string)

This notes the status of the data generated by the restore test. The status may be Deleting , Failed , or Successful .

DeletionStatusMessage -> (string)

This describes the restore job deletion status.