StartRestoreJob - AWS Backup

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

StartRestoreJob

Amazon リソースネーム (ARN) で識別された保存されたリソースを回復します。

リクエストの構文

PUT /restore-jobs HTTP/1.1 Content-type: application/json { "CopySourceTagsToRestoredResource": boolean, "IamRoleArn": "string", "IdempotencyToken": "string", "Metadata": { "string" : "string" }, "RecoveryPointArn": "string", "ResourceType": "string" }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

CopySourceTagsToRestoredResource

このパラメータはオプションです。これが True に等しい場合、バックアップに含まれるタグは復元されたリソースにコピーされます。

これは、 で作成されたバックアップにのみ適用されます AWS Backup。

型: ブール値

必須: いいえ

IamRoleArn

がターゲットリソースの作成 AWS Backup に使用する IAM ロールの Amazon リソースネーム (ARN)。例: arn:aws:iam::123456789012:role/S3Access

タイプ: 文字列

必須: いいえ

IdempotencyToken

別の StartRestoreJob への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。

タイプ: 文字列

必須: いいえ

Metadata

メタデータのキーと値のペアのセット。

GetRecoveryPointRestoreMetadata を呼び出して、バックアップ時にリソースに関する構成メタデータを取得できます。ただし、GetRecoveryPointRestoreMetadata によって提供される値に加えて値リソースの復元が必要になる場合があります。たとえば、元のリソースがすでに存在する場合は、新しいリソース名を指定する必要があります。

各リソースのメタデータの詳細については、以下を参照してください。

型: 文字列間のマッピング

必須: はい

RecoveryPointArn

たとえば、arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45などのリカバリポイントを一意に識別する ARN。

型: 文字列

必須: はい

ResourceType

次のいずれかのリソースのリカバリポイントを復元するジョブを開始します。

  • Aurora - Amazon Aurora

  • DocumentDB - Amazon DocumentDB

  • CloudFormation - AWS CloudFormation

  • DynamoDB - Amazon DynamoDB

  • EBS - Amazon Elastic Block Store

  • EC2 - Amazon Elastic Compute Cloud

  • EFS - Amazon Elastic File System

  • FSx - Amazon FSx

  • Neptune - Amazon Neptune

  • RDS - Amazon Relational Database Service

  • Redshift - Amazon Redshift

  • Storage Gateway - AWS Storage Gateway

  • S3 - Amazon Simple Storage Service

  • Timestream - Amazon Timestream

  • VirtualMachine - 仮想マシン

型: 文字列

パターン:^[a-zA-Z0-9\-\_\.]{1,50}$

必須: いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "RestoreJobId": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

RestoreJobId

リカバリポイントをリストアするジョブを一意に識別します。

型: 文字列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード:400

InvalidRequestException

リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。

HTTP ステータスコード:400

MissingParameterValueException

必須パラメータがないことを示します。

HTTP ステータスコード:400

ResourceNotFoundException

アクションに必要なリソースは存在しません。

HTTP ステータスコード:400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード:500

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。