이 페이지는 워크플로우 자동화 액션 카탈로그에서 사용할 수 있는 AWS Step Functions 액션에 대한 참조를 제공합니다. 워크플로우 정의 내에서 Step Functions 실행 및 상태 머신을 시작, 중지, 재구동 및 검사하려면 이러한 액션을 사용하십시오.
전제 조건
워크플로우 자동화에서 AWS Step Functions 작업을 사용하기 전에 다음을 확인하십시오:
- 적절한 권한이 있는 AWS 계정.
- AWS 자격 증명이 구성되었습니다(IAM 사용자 자격 증명, IAM 역할 ARN 또는 세션 자격 증명).
- Step Functions 작업에 필요한 IAM 권한입니다.
IAM 사용자 및 IAM 역할을 생성하는 방법과 AWS 작업 자동화와의 통합을 위한 정적 및 세션 AWS 자격 증명을 설정하는 방법에 대한 자세한 내용은 AWS 자격 증명 설정하기를 참조하세요.
필수 IAM 권한
필요한 권한은 워크플로우가 호출하는 Step Functions 작업에 따라 다릅니다. 아래 예제를 7개 작업을 모두 포함하는 최소 권한 정책의 템플릿으로 사용하십시오.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "states:StartExecution", "states:StopExecution", "states:RedriveExecution", "states:DescribeExecution", "states:ListExecutions", "states:DescribeStateMachine", "states:ListStateMachines" ], "Resource": "arn:aws:states:<region>:<account-id>:*" } ]}중요
<region> 및 <account-id>을(를) 실제 값으로 바꾸고, 가능한 경우 Resource을(를) 특정 상태 머신 또는 실행 ARN으로 제한하십시오.
Step Functions 실행 시작
작업 식별자는 aws.stepFunctions.startExecution입니다.
AWS Step Functions 상태 머신의 실행을 시작합니다. 성공 시 새 실행의 executionArn을(를) 반환하며, 이를 aws.stepFunctions.describeExecution에 전달하여 상태를 폴링할 수 있습니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 상태 머신이 배포된 AWS 리전입니다. |
|
stateMachineArn | 문자열 | 필수 항목입니다. 실행할 상태 머신의 ARN입니다. |
|
이름 | 문자열 | 선택 사항. 실행 이름입니다. 상태 머신마다 고유해야 합니다. 생략할 경우 UUID로 자동 생성됩니다.
상태 머신에서 다른 입력으로 실행 중인 실행의 이름을 재사용하면
을(를) 반환합니다.
상태 머신에서는 이름을 즉시 재사용할 수 있습니다. |
|
입력 | 문자열 | 선택 사항. 실행에 입력으로 전달할 JSON 문자열입니다. |
|
traceHeader | 문자열 | 선택 사항. 실행으로 전파할 X-Ray 트레이스 헤더입니다. |
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 응답입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 실행을 시작하지 못한 경우의 오류 메시지입니다. 성공 시
입니다. |
다음 예제는 조치 실행을 시작하고 다운스트림 단계를 위해 실행 ARN을 캡처합니다.
워크플로 예 |
|---|
|
Step Functions 실행 중지
작업 식별자는 aws.stepFunctions.stopExecution입니다.
실행 중인 Step Functions 실행을 중지합니다. AWS는 실행이 중지되면 해당 실행을 ABORTED (으)로 표시합니다.
중요
이 작업은 STANDARD 상태 머신에서만 지원됩니다. EXPRESS 실행을 중지할 수 없습니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 실행이 진행 중인 AWS 리전입니다. |
|
executionArn | 문자열 | 필수 항목입니다. 중지할 실행의 ARN입니다. |
|
오류 | 문자열 | 선택 사항. 실행이 중지된 이유를 설명하는 짧은 오류 코드입니다. |
|
원인 | 문자열 | 선택 사항. 실행이 중지된 이유에 대해 사람이 읽을 수 있는 설명입니다. |
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 응답입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 실행 중지에 실패한 경우의 오류 메시지입니다. 성공 시
입니다. |
다음 예제는 SLA를 초과한 실행을 중단합니다.
워크플로 예 |
|---|
|
Step Functions 실행 재구동
작업 식별자는 aws.stepFunctions.redriveExecution입니다.
실패하거나 시간이 초과되거나 중단된 Step Functions 실행을 다시 구동하여, 처음부터 다시 시작하지 않고 마지막으로 실패한 상태부터 재개합니다.
중요
이 작업은 STANDARD 상태 머신에서만 지원됩니다. 실행은 SUCCEEDED되지 않았고, 완료 후 14일 이내이며, 기록 이벤트가 24,999개 미만인 경우에만 다시 구동할 수 있습니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 실행이 수행된 AWS 리전입니다. |
|
executionArn | 문자열 | 필수 항목입니다. 다시 구동할 실행의 ARN입니다. |
|
clientToken | 문자열 | 선택 사항. 재구동 요청을 위한 멱등성 토큰입니다. 생략할 경우 SDK에서 자동으로 생성됩니다. |
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 응답입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 재구동이 실패한 경우의 오류 메시지입니다. 성공 시
입니다. |
다음 예제는 실패한 실행을 재구동하여 마지막으로 실패한 상태부터 재개합니다.
워크플로 예 |
|---|
|
Step Functions 실행 설명
작업 식별자는 aws.stepFunctions.describeExecution입니다.
Step Functions 실행에 대한 상태, 입력, 출력 및 타임스탬프를 반환합니다. aws.stepFunctions.startExecution이(가) 시작한 실행의 결과를 폴링하려면 이 작업을 사용하십시오.
중요
이 작업은 STANDARD 상태 머신 실행을 직접 지원합니다. Map Run이 디스패치한 EXPRESS 실행만 설명할 수 있습니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 실행이 수행된 AWS 리전입니다. |
|
executionArn | 문자열 | 필수 항목입니다. 설명할 실행의 ARN입니다. |
|
includedData | 열거형 | 선택 사항. 실행 정의를 반환할지 여부를 제어합니다.
권한을 사용할 수 없을 때 정의 복호화를 건너뛰려면
을(를) 사용하십시오. 기본값은
입니다. |
또는
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 실행 세부 정보입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 요청이 실패한 경우의 오류 메시지. 성공 시
입니다. |
다음 예제는 실행 상태를 폴링하고 다운스트림 단계를 위해 출력을 캡처합니다.
워크플로 예 |
|---|
|
Step Functions 실행 나열
작업 식별자는 aws.stepFunctions.listExecutions입니다.
AWS Step Functions 상태 머신 또는 맵 실행의 실행을 나열하며, 선택적으로 상태별로 필터링할 수 있습니다. 결과는 최신순으로 정렬됩니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 실행을 나열할 AWS 리전입니다. |
|
stateMachineArn | 문자열 | 선택 사항. 실행을 나열할 상태 머신의 ARN입니다. 이것 또는
을(를) 제공하십시오. 둘 다 제공해서는 안 됩니다.
상태 머신은 직접 나열할 수 없습니다 ― 대신
을(를) 사용하여 분산 맵에서 하위 실행을 나열하십시오. |
|
mapRunArn | 문자열 | 선택 사항. 하위 실행을 나열할 맵 실행의 ARN입니다. 이것 또는
을(를) 제공하십시오. 둘 다 제공해서는 안 됩니다.
을(를) 사용할 때 필수입니다. |
|
statusFilter | 열거형 | 선택 사항. 상태별로 실행을 필터링합니다.
에는
이(가) 필요합니다. |
|
|
|
|
|
|
최대 결과 | Int | 선택 사항. 반환할 실행의 최대 수입니다. 기본값은 100이며, 최대 1000입니다. |
|
nextToken | 문자열 | 선택 사항. 이전 호출의
에서 가져온 페이지네이션 토큰입니다. 24시간 후에 만료됩니다. |
|
redriveFilter | 열거형 | 선택 사항. 재구동 여부에 따라 실행을 필터링합니다. |
또는
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 실행 목록입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 요청이 실패한 경우의 오류 메시지. 성공 시
입니다. |
다음 예제는 상태 머신에 대해 현재 실행 중인 실행을 나열합니다.
워크플로 예 |
|---|
|
상태 머신 설명
작업 식별자는 aws.stepFunctions.describeStateMachine입니다.
AWS Step Functions 상태 머신의 정의, IAM 역할, 로깅 설정, 유형(STANDARD 또는 EXPRESS) 및 상태를 반환합니다.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 상태 머신이 배포된 AWS 리전입니다. |
|
stateMachineArn | 문자열 | 필수 항목입니다. 설명할 상태 머신의 ARN입니다. 버전 ARN도 허용합니다. |
|
includedData | 열거형 | 선택 사항. 상태 머신 정의 반환을 건너뛰고 정의가 KMS로 암호화된 경우
이(가) 필요하지 않도록 하려면
을(를) 사용하십시오. 기본값은
입니다. |
또는
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 상태 머신 세부 정보입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 요청이 실패한 경우의 오류 메시지. 성공 시
입니다. |
다음 예제는 상태 머신의 유형과 정의를 가져옵니다.
워크플로 예 |
|---|
|
상태 머신 나열
작업 식별자는 aws.stepFunctions.listStateMachines입니다.
계정 및 리전의 AWS Step Functions 상태 머신을 나열합니다. 대규모 결과 세트를 검색하려면 페이지네이션 입력을 사용하십시오.
다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
awsRoleArn | 문자열 | 선택 사항. 수임할 IAM 역할 ARN입니다. 권장됩니다. 두 가지를 모두 제공하는 경우 키 기반 자격 증명보다 우선합니다. |
|
awsAccessKeyId | 문자열(시크릿) | 선택 사항. AWS 액세스 키 ID입니다. 비밀 구문으로 전달되어야 합니다. |
|
awsSecretAccessKey | 문자열(시크릿) | 선택 사항. AWS 비밀 액세스 키입니다. 비밀로 전달되어야 합니다. |
|
awsSessionToken | 문자열(시크릿) | 선택 사항. 임시 자격 증명을 위한 AWS 세션 토큰입니다. 비밀 구문으로 전달되어야 합니다. |
|
지역 | 문자열 | 필수 항목입니다. 상태 머신을 나열할 AWS 리전입니다. |
|
최대 결과 | Int | 선택 사항. 반환할 상태 머신의 최대 수입니다. 기본값은 100이며, 최대값은 1,000입니다. |
|
nextToken | 문자열 | 선택 사항. 이전 호출의
에서 가져온 페이지네이션 토큰입니다. 24시간 후에 만료됩니다. |
|
selectors | 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.
산출 | 유형 | 설명 |
|---|---|---|
response | 물체 | AWS Step Functions API의 상태 머신 목록입니다. |
success | 부울 |
성공 시, 실패 시
입니다. |
errorMessage | 문자열 | 요청이 실패한 경우의 오류 메시지. 성공 시
입니다. |
다음 예제는 계정의 상태 머신을 나열하고 다운스트림 단계를 위해 결과를 캡처합니다.
워크플로 예 |
|---|
|
무엇 향후 계획
AWS 작업 및 워크플로우 자동화 작업을 계속하려면 다음 리소스를 참조하십시오.
- AWS 자격 증명 설정: AWS 작업에 사용할 IAM 역할 및 액세스 키를 구성하십시오.
- AWS Execute API: 전용 작업을 사용할 수 없을 때 모든 AWS API 호출을 직접 수행합니다.
- 워크플로우 예제: AWS 작업을 사용하는 실제 워크플로우 예제를 참조하십시오.