DescribeWorldTemplate - AWS RoboMaker
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

サポート終了通知: 2025 年 9 月 10 日、 AWS は のサポートを中止します AWS RoboMaker。2025 年 9 月 10 日以降、 AWS RoboMaker コンソールまたは AWS RoboMaker リソースにアクセスできなくなります。コンテナ化されたシミュレーションの実行に役立つ AWS Batch への移行の詳細については、このブログ記事 を参照してください。

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

DescribeWorldTemplate

重要

サポート終了通知: 2025 年 9 月 10 日、 AWS は のサポートを中止します AWS RoboMaker。2025 年 9 月 10 日以降、 AWS RoboMaker コンソールまたは AWS RoboMaker リソースにアクセスできなくなります。コンテナ化されたシミュレーションの実行に役立つ AWS Batch への移行の詳細については、このブログ記事 を参照してください。

ワールドテンプレートを記述します。

リクエストの構文

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

{
   "template": "string"
}

URI リクエストパラメータ

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

リクエスト本文

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

template

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

型: 文字列

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

Pattern: arn:.*

必須：はい

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "createdAt": number,
   "lastUpdatedAt": number,
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string"
}

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

arn

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

型: 文字列

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

パターン: arn:.*

clientRequestToken

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

型: 文字列

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

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

createdAt

ワールドテンプレートが作成されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

lastUpdatedAt

ワールドテンプレートが最後に更新されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

name

ワールドテンプレートの名前。

型: 文字列

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

パターン: .*

tags

ワールドテンプレートにアタッチされているタグキーとタグ値を含むマップ。

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

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

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

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

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

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

version

使用しているワールドテンプレートのバージョン。

型: 文字列

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

Pattern: .*

エラー

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

InternalServerException

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

HTTP ステータスコード: 500

InvalidParameterException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

ThrottlingException

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

HTTP ステータスコード: 400

以下の資料も参照してください。

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