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

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

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

DescribeRobotApplication

重要

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

ロボットアプリケーションを記述します。

リクエストの構文

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

{
   "application": "string",
   "applicationVersion": "string"
}

URI リクエストパラメータ

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

リクエストボディ

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

application

ロボットアプリケーションの Amazon リソースネーム (ARN)。

タイプ: 文字列

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

Pattern: arn:.*

必須: はい

applicationVersion

記述するロボットアプリケーションのバージョン。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 255 です。

パターン: (\$LATEST)|[0-9]*

必須: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "environment": { 
      "uri": "string"
   },
   "imageDigest": "string",
   "lastUpdatedAt": number,
   "name": "string",
   "revisionId": "string",
   "robotSoftwareSuite": { 
      "name": "string",
      "version": "string"
   },
   "sources": [ 
      { 
         "architecture": "string",
         "etag": "string",
         "s3Bucket": "string",
         "s3Key": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "version": "string"
}

レスポンス要素

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

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

arn

ロボットアプリケーションの Amazon リソースネーム (ARN)。

タイプ: 文字列

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

パターン: arn:.*

environment

ロボットアプリケーションの作成に使用した Docker イメージ URI が含まれているオブジェクト。

型: Environment オブジェクト

imageDigest

ロボットアプリケーションに使用する Docker イメージの SHA256 識別子。

タイプ: 文字列

長さの制約: 最小長は 0 です。最大長は 72 です。

パターン: [Ss][Hh][Aa]256:[0-9a-fA-F]{64}

lastUpdatedAt

ロボットアプリケーションが最後に更新されたときの、エポックからのミリ秒単位の時間。

タイプ: タイムスタンプ

name

ロボットアプリケーションの名前。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 255 です。

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

revisionId

ロボットアプリケーションのリビジョン ID。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 40 です。

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

robotSoftwareSuite

ロボットアプリケーションで使用するロボットソフトウェアスイート。

型: RobotSoftwareSuite オブジェクト

sources

ロボットアプリケーションのソース。

型: Source オブジェクトの配列

tags

指定のロボットアプリケーションに追加されたすべてのタグのリスト。

型: 文字列から文字列へのマップ

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

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

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

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

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

version

ロボットアプリケーションのバージョン。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 255 です。

パターン: (\$LATEST)|[0-9]*

エラー

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

InternalServerException

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

HTTP ステータスコード: 500

InvalidParameterException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

ThrottlingException

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

HTTP ステータスコード: 400

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

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