GetRestoreJobMetadataCommand

This request returns the metadata for the specified restore job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, GetRestoreJobMetadataCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, GetRestoreJobMetadataCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // GetRestoreJobMetadataInput
  RestoreJobId: "STRING_VALUE", // required
};
const command = new GetRestoreJobMetadataCommand(input);
const response = await client.send(command);
// { // GetRestoreJobMetadataOutput
//   RestoreJobId: "STRING_VALUE",
//   Metadata: { // Metadata
//     "<keys>": "STRING_VALUE",
//   },
// };

GetRestoreJobMetadataCommand Input

Parameter
Type
Description
RestoreJobId
Required
string | undefined

This is a unique identifier of a restore job within Backup.

GetRestoreJobMetadataCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Metadata
Record<string, string> | undefined

This contains the metadata of the specified backup job.

RestoreJobId
string | undefined

This is a unique identifier of a restore job within Backup.

Throws

Name
Fault
Details
InvalidParameterValueException
client

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException
client

Indicates that a required parameter is missing.

ResourceNotFoundException
client

A resource that is required for the action doesn't exist.

ServiceUnavailableException
server

The request failed due to a temporary failure of the server.

BackupServiceException
Base exception class for all service exceptions from Backup service.