DescribeWorldTemplate - AWS RoboMaker

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

DescribeWorldTemplate

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

リクエストの構文

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" }

レスポンス要素

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

サービスから以下のデータが 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 です。

パターン:.*

エラー

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

InternalServerException

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

HTTP ステータスコード:500

InvalidParameterException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ThrottlingException

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

HTTP ステータスコード:400

その他の参照資料

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