aws:executeAwsApi — AWS API オペレーションの呼び出しと実行 - AWS Systems Manager

aws:executeAwsApi — AWS API オペレーションの呼び出しと実行

AWS API オペレーションを呼び出し、実行します。API 操作のほとんどはサポートされていますが、すべての API オペレーションがテストされているわけではありません。GetObject オペレーションなどのストリーミング API オペレーションはサポートされていません。使用する API オペレーションがストリーミングオペレーションかどうかわからない場合は、サービスの「Boto3」ドキュメントを参照して、API でストリーミング入力または出力が必要かどうかを確認してください。このアクションで使用される Boto3 のバージョンは定期的に更新されます。ただし、新しい Boto3 バージョンのリリース後、変更がこのアクションに反映されるまでに最大で数週間かかる場合があります。各 aws:executeAwsApi アクションは、最大 25 秒間実行できます。このアクションの使用例については、「その他のランブックの例」を参照してください。

入力

入力は、選択した API オペレーションによって定義されます。

YAML
action: aws:executeAwsApi
inputs:
  Service: The official namespace of the service
  Api: The API operation or method name
  API operation inputs or parameters: A value
outputs: # These are user-specified outputs
- Name: The name for a user-specified output key
  Selector: A response object specified by using jsonpath format
  Type: The data type
JSON
{
   "action":"aws:executeAwsApi",
   "inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API operation or method name",
      "API operation inputs or parameters":"A value"
   },
   "outputs":[ These are user-specified outputs
      {
         "Name":"The name for a user-specified output key",
         "Selector":"A response object specified by using JSONPath format",
         "Type":"The data type"
      }
   ]
}
サービス

実行する API オペレーションを含む AWS のサービスの名前空間。サポートされている AWS のサービスの名前空間のリストは、AWS SDK for Python (Boto3) の利用可能なサービスを参照してください。名前空間は、[クライアント] セクションにあります。例えば、Systems Manager の名前空間は ssm です。Amazon Elastic Compute Cloud (Amazon EC2) の名前空間は、ec2 です。

型: 文字列

必須: はい

Api

実行する API オペレーションの名前。API オペレーション (メソッド) は、以下の「サービスリファレンス」ページの左側のナビゲーションでサービスを選択することで表示できます。呼び出すサービスの [Client (クライアント)] セクションでメソッドを選択します。例えば、Amazon Relational Database Service (Amazon RDS) のすべての API オペレーション (メソッド) は、Amazon RDS メソッドのページに一覧表示されます。

型: 文字列

必須: はい

API オペレーション入力

1 つ以上の API オペレーションを入力します。使用できる入力 (パラメータ) は、以下の「サービスリファレンス」ページの左側のナビゲーションでサービスを選択することで表示できます。呼び出すサービスの [Client (クライアント)] セクションでメソッドを選択します。例えば、Amazon RDS のすべてのメソッドは、Amazon RDS メソッドページに一覧表示されています。describe_db_instances メソッドを選択し、下にスクロールして、[DBInstanceIdentifier]、[Name (名前)]、および [Values (値)] などの使用可能なパラメータを表示します。

YAML
inputs:
  Service: The official namespace of the service
  Api: The API operation name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value
JSON
"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API operation name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

型: 選択した API オペレーションによって決まります

必須: はい

出力

出力は、選択した API オペレーションからの応答に基づいてユーザーによって指定されます。

名前

出力の名前。

型: 文字列

必須: はい

Selector

応答オブジェクト内の特定の属性への JSONPath。レスポンスオブジェクトは、以下の「サービスリファレンス」ページの左側のナビゲーションでサービスを選択することで表示できます。呼び出すサービスの [Client (クライアント)] セクションでメソッドを選択します。例えば、Amazon RDS のすべてのメソッドは、Amazon RDS メソッドページに一覧表示されています。describe_db_instances メソッドを選択し、[Response Structure (レスポンス構造)] セクションまで下にスクロールします。[DBInstances] は応答オブジェクトとして表示されます。

型: 整数型、ブール型、文字列型、StringList、StringMap、または MapList

必須: はい

タイプ

レスポンス要素のデータ型。

型: 可変

必須: はい