DescribeWorldExportJob - AWS RoboMaker
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

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

DescribeWorldExportJob

ワールドのエクスポートジョブを記述します

リクエストの構文

POST /describeWorldExportJob HTTP/1.1
Content-type: application/json

{
   "job": "string"
}

URI リクエストパラメータ

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

リクエストボディ

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

job

記述するワールドエクスポートジョブの Amazon リソースネーム (ARN)。

型: 文字列

長さの制限：最小長は 1 です。最大長は 1224 です。

Pattern: arn:.*

必須：はい

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "createdAt": number,
   "failureCode": "string",
   "failureReason": "string",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "worlds": [ "string" ]
}

レスポンス要素

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

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

arn

ワールドエクスポートジョブの Amazon リソースネーム (ARN)。

タイプ: 文字列

長さの制限：最小長は 1 です。最大長は 1224 です。

パターン: arn:.*

clientRequestToken

リクエストのべき等のために割り当てる一意の識別子 (大文字と小文字を区別)。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9_\-=]*

createdAt

ワールドのエクスポートジョブが作成されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

failureCode

ワールドエクスポートジョブが失敗した場合の失敗コード:

InternalServiceError

内部サービスエラー。

LimitExceeded

リクエストされたリソースが最大許容数を超えているか、または同時ストリームリクエストの数が最大許容数を超えています。

ResourceNotFound

指定したリソースが見つかりませんでした。

RequestThrottled

リクエストがスロットリングされました。

InvalidInput

リクエストの入力パラメータが無効です。

型: 文字列

有効な値：InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AccessDenied

failureReason

ワールドエクスポートジョブが失敗した理由。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 1,024 です。

パターン: .*

iamRole

ワールドエクスポートプロセスで Amazon S3 バケットへのアクセスとエクスポートの実行に使用される IAM ロール。

型: 文字列

長さの制限：最小長は 1 です。最大長は 255 です。

パターン: arn:aws:iam::\w+:role/.*

outputLocation

出力場所。

タイプ：OutputLocation オブジェクト

status

ワールドエクスポートジョブのステータス。

保留中

ワールドエクスポートジョブのリクエストが保留中です。

実行中

ワールドエクスポートジョブが実行中です。

完了

ワールドエクスポートジョブが完了しました。

[失敗]

ワールドエクスポートジョブが失敗しました。詳細については、「failureCode」と「 failureReason」 を参照してください。

キャンセル

ワールドエクスポートジョブがキャンセルされました。

キャンセル中

ワールドエクスポートジョブをキャンセルしています。

型: 文字列

有効な値：Pending | Running | Completed | Failed | Canceling | Canceled

tags

ワールドエクスポートジョブにアタッチされているタグキーとタグ値を含むマップ。

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

マップエントリ: 最小数は 0 項目です。最大数は 50 項目です。

キーの長さ制限: 最小長さは 1 です。最大長は 128 です。

キーパターン: [a-zA-Z0-9 _.\-\/+=:]*

値の長さの制限: 最小長は 0 です。最大長は 256 です。

値のパターン: [a-zA-Z0-9 _.\-\/+=:]*

worlds

エクスポートするワールドに対応する Amazon リソースネーム (ARN) のリスト。

タイプ：文字列の配列

配列メンバー: 最小数は 1 項目です。最大数は 100 項目です。

長さの制限：最小長は 1 です。最大長は 1224 です。

パターン：arn:.*

エラー

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

InternalServerException

AWS RoboMaker にサービスの問題が発生しました。もう一度やり直してください。

HTTP ステータスコード：500

InvalidParameterException

リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。返されたメッセージはエラー値の説明を提供します。​

HTTP ステータスコード：400

ResourceNotFoundException

指定されたリソースは存在しません。

HTTP ステータスコード：400

ThrottlingException

AWS RoboMaker は一時的にリクエストを処理できません。もう一度やり直してください。

HTTP ステータスコード：400

その他の参照資料

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