DescribeWorldGenerationJob - AWS RoboMaker

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

DescribeWorldGenerationJob

ワールド生成ジョブを記述します。

リクエストの構文

POST /describeWorldGenerationJob 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", "finishedWorldsSummary": { "failureSummary": { "failures": [ { "failureCode": "string", "failureCount": number, "sampleFailureReason": "string" } ], "totalFailureCount": number }, "finishedCount": number, "succeededWorlds": [ "string" ] }, "status": "string", "tags": { "string" : "string" }, "template": "string", "worldCount": { "floorplanCount": number, "interiorCountPerFloorplan": number }, "worldTags": { "string" : "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 | AllWorldGenerationFailed

failureReason

ワールド生成ジョブが失敗した理由。

型: 文字列

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

パターン: .*

finishedWorldsSummary

完了したワールドに関する概要情報。

タイプ:FinishedWorldsSummary オブジェクト

status

ワールド生成ジョブのステータス:

保留中

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

実行中

ワールド生成ジョブが実行中です。

完了

ワールド生成ジョブが完了しました。

[失敗]

ワールド生成ジョブが失敗しました。詳細については、「failureCode」を参照してください。

PartialFailed

一部のワールドが生成されませんでした。

キャンセル

ワールド生成ジョブがキャンセルされました。

キャンセル中

ワールド生成ジョブをキャンセルしています。

型: 文字列

有効な値:Pending | Running | Completed | Failed | PartialFailed | Canceling | Canceled

tags

ワールド生成ジョブにアタッチされているタグキーとタグ値を含むマップ。

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

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

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

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

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

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

template

ワールドテンプレートの Amazon リソースネーム (ARN)。

タイプ: 文字列

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

パターン: arn:.*

worldCount

ワールドカウントに関する情報。

タイプ:WorldCount オブジェクト

worldTags

生成したワールドにアタッチされているタグキーとタグ値を含むマップ。

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

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

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

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

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

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

エラー

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

InternalServerException

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

HTTP ステータスコード:500

InvalidParameterException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ThrottlingException

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

HTTP ステータスコード:400

その他の参照資料

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