aws:executeAwsApi— 调用并运行AmazonAPI 操作 - Amazon Web Services Systems Manager
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

aws:executeAwsApi— 调用并运行AmazonAPI 操作

调用并运行 Amazon API 操作。支持大多数 API 操作,但某些 API 操作未经过测试。例如,以下 API 操作支持:CreateImage删除存储桶RebootDBInstance, 和CreateGroups。不支持流式处理 API 操作,例如 Get Object 操作。有关如何使用此操作的更多信息和示例,请参阅调用其他AmazonSystems Manager 自动化运行手册中的服务

Inputs

输入由您选择的 API 操作定义。

YAML
action: aws:executeAwsApi inputs: Service: The official namespace of the service Api: The API action or method name API action 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 action or method name", "API action 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 操作的 Amazon 服务命名空间。您可以查看受支持的Amazon服务命名空间可用服务的AmazonSDK for Python (Boto3) 的开发工具包。可以在 Client (客户端) 部分找到此命名空间。例如,Systems Manager 的命名空间为ssm。Amazon Elastic Compute Cloud (Amazon EC2) 的命名空间是ec2

类型: 字符串

:必需 是

API

要运行的 API 操作的名称。您可以在以下服务参考页面的左侧导航栏中选择服务来查看 API 操作(也称为方法)。在要调用的服务的 Client 部分中选择一种方法。例如,以下页面中列出了 Amazon 关系数据库服务 (Amazon RDS) 的所有 API 操作(方法):Amazon RDS 方法

类型: 字符串

:必需 是

API 操作输入

一个或多个 API 操作输入。您可以在以下服务参考页面的左侧导航栏中选择服务来查看可用的输入(也称为参数)。在要调用的服务的 Client 部分中选择一种方法。例如,以下页面中列出了 Amazon RDS 的所有方法:Amazon RDS 方法。选择 describe_db_instances 方法并向下滚动以查看可用的参数,例如 DBInstanceIdentifierNameValues

YAML
inputs: Service: The official namespace of the service Api: The API action 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 action name", "API input 1":"A value", "API Input 2":"A value", "API Input 3":"A value" }

类型: 由选择的 API 操作确定

:必需 是

Outputs

输出由用户根据所选 API 操作的响应指定。

名称

输出的名称。

类型: 字符串

:必需 是

Selector

响应对象中特定属性的 JSONPath。您可以在以下服务参考页面的左侧导航栏中选择服务来查看响应对象。在要调用的服务的 Client 部分中选择一种方法。例如,以下页面中列出了 Amazon RDS 的所有方法:Amazon RDS 方法。选择 describe_db_instances 方法,然后向下滚动到 Response Structure (响应结构) 部分。DBInstances 被列为响应对象。

类型: Integer、Boolean、String、StringList、StringMap 或 MapList

:必需 是

类型

响应元素的数据类型。

类型: 变化

:必需 是