StartCopyJob - AWS Backup

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

StartCopyJob

ジョブを開始し、指定したリソースの 1 回限りのコピーを作成します。

連続バックアップをサポートしません。

リクエストの構文

PUT /copy-jobs HTTP/1.1 Content-type: application/json { "DestinationBackupVaultArn": "string", "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "RecoveryPointArn": "string", "SourceBackupVaultName": "string" }

URI リクエストパラメータ

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

リクエストボディ

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

DestinationBackupVaultArn

たとえば、arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault などのコピーするバックアップボールトを一意に識別する Amazon リソースネーム (ARN) です。

型: 文字列

必須: はい

IamRoleArn

たとえば、arn:aws:iam::123456789012:role/S3Access などのターゲットリカバリポイントのコピーに使用する IAM ロール ARN を指定します。

型: 文字列

必須: はい

IdempotencyToken

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

タイプ: 文字列

必須: いいえ

Lifecycle

復旧ポイントがコールドストレージに移行するか、削除されるまでの時間を日数で指定します。

コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、コンソールでは、保持設定は、日数設定後のコールドへの移行よりも 90 日長くする必要があります。バックアップがコールドに移行した後、日数設定をコールドに移行することはできません。

コールドストレージに移行できるリソースタイプは、「リソース別の機能の可用性」の表に記載されています。他のリソースタイプでは、この式は AWS Backup 無視されます。

既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、 MoveToColdStorageAfterDaysと に -1 を指定しますDeleteAfterDays

タイプ:Lifecycle オブジェクト

必須:いいえ

RecoveryPointArn

たとえば、arn:aws:backup:us-east-1:123456789012:recovery-point:1eb3456789012:recovery-point:1eb3456789012:recovery-point: 1eb3456789012 などのコピージョブに使用するリカバリポイントを一意に識別する ARN。

型: 文字列

必須: はい

SourceBackupVaultName

バックアップを保存する論理ソースコンテナの名前。バックアップボールトは、作成に使用した アカウントと作成先の AWS リージョンに固有の名前で識別されます。それらは、小文字の英文字、数字、およびハイフン (-) で構成されます。

型: 文字列

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

必須:はい

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "CopyJobId": "string", "CreationDate": number, "IsParent": boolean }

レスポンス要素

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

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

CopyJobId

コピージョブを一意に識別する。

型: 文字列

CreationDate

コピージョブが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。CreationDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

IsParent

これは親 (複合) バックアップジョブであることを示す、返されたブール値です。

型: ブール値

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード:400

InvalidRequestException

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

HTTP ステータスコード:400

LimitExceededException

たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。

HTTP ステータスコード:400

MissingParameterValueException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ServiceUnavailableException

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

HTTP ステータスコード:500

その他の参照資料

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