翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeWorld
ワールドを記述します。
リクエストの構文
POST /describeWorld HTTP/1.1
Content-type: application/json
{
"world": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- world
-
記述するワールドの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最小長は 1 です。最大長は 1224 です。
Pattern:
arn:.*必須：はい
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": number,
"generationJob": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldDescriptionBody": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- arn
-
ワールドの Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制限：最小長は 1 です。最大長は 1224 です。
パターン:
arn:.* - createdAt
-
ワールドが作成されたときの、エポックからのミリ秒単位の時間。
型: タイムスタンプ
- generationJob
-
そのワールドを生成したワールド生成ジョブの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最小長は 1 です。最大長は 1224 です。
パターン:
arn:.* -
ワールドにアタッチされているタグキーとタグ値を含むマップ。
型: 文字列間のマッピング
マップエントリ: 最小数は 0 項目です。最大数は 50 項目です。
キーの長さ制限: 最小長さは 1 です。最大長は 128 です。
キーパターン:
[a-zA-Z0-9 _.\-\/+=:]*値の長さの制限: 最小長は 0 です。最大長は 256 です。
値のパターン:
[a-zA-Z0-9 _.\-\/+=:]* - template
-
ワールドテンプレート。
型: 文字列
長さの制限：最小長は 1 です。最大長は 1224 です。
パターン:
arn:.* - worldDescriptionBody
-
ワールドの内容を記述する JSON 形式の文字列を返します。
型: 文字列
長さの制限：最小長は 1 です。最大長は 262,144 です。
パターン：
[\S\s]+
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServerException
-
AWS RoboMaker にサービスの問題が発生しました。もう一度やり直してください。
HTTP ステータスコード：500
- InvalidParameterException
-
リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。返されたメッセージはエラー値の説明を提供します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード：400
- ThrottlingException
-
AWS RoboMaker は一時的にリクエストを処理できません。もう一度やり直してください。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDK の 1 つでこの API を使用する方法の詳細については、以下を参照してください。
