aws:executeAwsApi - AWS API 작업 호출 및 실행 - AWS Systems Manager

aws:executeAwsApi - AWS API 작업 호출 및 실행

AWS API 작업을 호출하여 실행합니다. 일부 API 작업이 테스트되지 않았더라도 대부분의 API 작업이 지원됩니다. GetObject 작업과 같은 스트리밍 API 작업은 지원되지 않습니다. 사용하려는 API 작업이 스트리밍 작업인지 확실하지 않은 경우 API에 스트리밍 입력 또는 출력이 필요한지 여부를 결정하는 서비스에 대한 Boto3 설명서를 검토하세요. 이 작업에 사용되는 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"
      }
   ]
}
Service

실행하려는 API 작업을 포함하는 AWS 서비스 네임스페이스입니다. AWS SDK for Python (Boto3)의 사용 가능한 서비스에서 지원되는 AWS 서비스 네임스페이스 목록을 볼 수 있습니다. 네임스페이스는 클라이언트 섹션에서 찾을 수 있습니다. 예를 들면 Systems Manager의 네임스페이스는 ssm입니다. Amazon Elastic Compute Cloud(Amazon EC2)의 네임스페이스는 ec2입니다.

타입: 문자열

필수 항목 여부: 예

Api

실행할 API 작업의 이름입니다. 다음 [서비스 참조(Services Reference)] 페이지의 왼쪽 탐색 영역에서 서비스를 선택하여 API 작업(메서드라고도 함)을 볼 수 있습니다. 호출할 서비스에 대한 클라이언트 섹션에서 메서드를 선택합니다. 예를 들어 Amazon Relational Database Service(Amazon RDS)에 대한 모든 API 작업(메서드)이 Amazon RDS 메서드 페이지에 나열됩니다.

타입: 문자열

필수 항목 여부: 예

API 작업 입력

하나 이상의 API 작업 입력입니다. 다음 서비스 참조 페이지의 왼쪽 탐색 영역에서 서비스를 선택하여 사용할 수 있는 입력(파라미터)을 볼 수 있습니다. 호출할 서비스에 대한 클라이언트 섹션에서 메서드를 선택합니다. 예를 들어 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입니다. 다음 서비스 참조 페이지의 왼쪽 탐색 영역에서 서비스를 선택하여 응답 객체를 볼 수 있습니다. 호출할 서비스에 대한 클라이언트 섹션에서 메서드를 선택합니다. 예를 들어 Amazon RDS에 대한 모든 메서드는 Amazon RDS 메서드 페이지에 나열됩니다. describe_db_instances 메서드를 선택하고 Response Structure(응답 구조) 섹션이 있는 아래쪽으로 스크롤합니다. DBInstances가 응답 객체로 나열됩니다.

형식: Integer, Boolean, String, StringList, StringMap, MapList

필수 항목 여부: 예

유형

응답 요소의 데이터 유형입니다.

형식: 다양

필수 항목 여부: 예