openapi: 3.2.0 info: version: '2016-11-23' x-release: v4 title: AWS Step Functions API description: 'Step Functions Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.' x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: states x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/states-2016-11-23.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://states.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SFN multi-region endpoint - url: https://states.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SFN multi-region endpoint - url: http://states.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SFN endpoint for China (Beijing) and China (Ningxia) - url: https://states.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SFN endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: AWS Step Functions paths: /#X-Amz-Target=AWSStepFunctions.CreateActivity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateActivity description: 'Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity''s idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateActivityOutput' '480': description: ActivityLimitExceeded content: application/json: schema: $ref: '#/components/schemas/ActivityLimitExceeded' '481': description: InvalidName content: application/json: schema: $ref: '#/components/schemas/InvalidName' '482': description: TooManyTags content: application/json: schema: $ref: '#/components/schemas/TooManyTags' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateActivityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.CreateActivity summary: AWS Step Functions - Create Activity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.CreateStateMachine: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateStateMachine description: 'Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine''s idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateStateMachineOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: InvalidDefinition content: application/json: schema: $ref: '#/components/schemas/InvalidDefinition' '482': description: InvalidName content: application/json: schema: $ref: '#/components/schemas/InvalidName' '483': description: InvalidLoggingConfiguration content: application/json: schema: $ref: '#/components/schemas/InvalidLoggingConfiguration' '484': description: InvalidTracingConfiguration content: application/json: schema: $ref: '#/components/schemas/InvalidTracingConfiguration' '485': description: StateMachineAlreadyExists content: application/json: schema: $ref: '#/components/schemas/StateMachineAlreadyExists' '486': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' '487': description: StateMachineLimitExceeded content: application/json: schema: $ref: '#/components/schemas/StateMachineLimitExceeded' '488': description: StateMachineTypeNotSupported content: application/json: schema: $ref: '#/components/schemas/StateMachineTypeNotSupported' '489': description: TooManyTags content: application/json: schema: $ref: '#/components/schemas/TooManyTags' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateStateMachineInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.CreateStateMachine summary: AWS Step Functions - Create State Machine x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DeleteActivity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteActivity description: Deletes an activity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteActivityOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteActivityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DeleteActivity summary: AWS Step Functions - Delete Activity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DeleteStateMachine: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteStateMachine description: 'Deletes a state machine. This is an asynchronous operation: It sets the state machine''s status to DELETING and begins the deletion process. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. For EXPRESS state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DeleteStateMachine summary: AWS Step Functions - Delete State Machine x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DescribeActivity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeActivity description: 'Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeActivityOutput' '480': description: ActivityDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ActivityDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeActivityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeActivity summary: AWS Step Functions - Describe Activity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DescribeExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeExecution description: 'Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeExecutionOutput' '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeExecutionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeExecution summary: AWS Step Functions - Describe Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DescribeMapRun: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeMapRun description: Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeMapRunOutput' '480': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeMapRunInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeMapRun summary: AWS Step Functions - Describe Map Run x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DescribeStateMachine: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeStateMachine description: 'Provides information about a state machine''s definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state''s label. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeStateMachine summary: AWS Step Functions - Describe State Machine x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeStateMachineForExecution description: 'Provides information about a state machine''s definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineForExecutionOutput' '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineForExecutionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeStateMachineForExecution summary: AWS Step Functions - Describe State Machine for Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.GetActivityTask: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetActivityTask description: 'Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. This API action isn''t logged in CloudTrail. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetActivityTaskOutput' '480': description: ActivityDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ActivityDoesNotExist' '481': description: ActivityWorkerLimitExceeded content: application/json: schema: $ref: '#/components/schemas/ActivityWorkerLimitExceeded' '482': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetActivityTaskInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.GetActivityTask summary: AWS Step Functions - Get Activity Task x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.GetExecutionHistory: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetExecutionHistory description: 'Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This API action is not supported by EXPRESS state machines.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetExecutionHistoryOutput' '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetExecutionHistoryInput' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.GetExecutionHistory summary: AWS Step Functions - Get Execution History x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.ListActivities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListActivities description: 'Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListActivitiesOutput' '480': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListActivitiesInput' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListActivities summary: AWS Step Functions - List Activities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.ListExecutions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListExecutions description: 'Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListExecutionsOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' '482': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' '483': description: StateMachineTypeNotSupported content: application/json: schema: $ref: '#/components/schemas/StateMachineTypeNotSupported' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListExecutionsInput' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListExecutions summary: AWS Step Functions - List Executions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.ListMapRuns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListMapRuns description: Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMapRunsOutput' '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListMapRunsInput' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListMapRuns summary: AWS Step Functions - List Map Runs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.ListStateMachines: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListStateMachines description: 'Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListStateMachinesOutput' '480': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListStateMachinesInput' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListStateMachines summary: AWS Step Functions - List State Machines x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.ListTagsForResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTagsForResource description: 'List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListTagsForResource summary: AWS Step Functions - List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.SendTaskFailure: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendTaskFailure description: Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendTaskFailureOutput' '480': description: TaskDoesNotExist content: application/json: schema: $ref: '#/components/schemas/TaskDoesNotExist' '481': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' '482': description: TaskTimedOut content: application/json: schema: $ref: '#/components/schemas/TaskTimedOut' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendTaskFailureInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.SendTaskFailure summary: AWS Step Functions - Send Task Failure x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.SendTaskHeartbeat: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendTaskHeartbeat description: 'Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine''s Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine''s Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendTaskHeartbeatOutput' '480': description: TaskDoesNotExist content: application/json: schema: $ref: '#/components/schemas/TaskDoesNotExist' '481': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' '482': description: TaskTimedOut content: application/json: schema: $ref: '#/components/schemas/TaskTimedOut' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendTaskHeartbeatInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.SendTaskHeartbeat summary: AWS Step Functions - Send Task Heartbeat x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.SendTaskSuccess: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendTaskSuccess description: Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendTaskSuccessOutput' '480': description: TaskDoesNotExist content: application/json: schema: $ref: '#/components/schemas/TaskDoesNotExist' '481': description: InvalidOutput content: application/json: schema: $ref: '#/components/schemas/InvalidOutput' '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' '483': description: TaskTimedOut content: application/json: schema: $ref: '#/components/schemas/TaskTimedOut' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendTaskSuccessInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.SendTaskSuccess summary: AWS Step Functions - Send Task Success x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.StartExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartExecution description: 'Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. StartExecution is not idempotent for EXPRESS workflows.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartExecutionOutput' '480': description: ExecutionLimitExceeded content: application/json: schema: $ref: '#/components/schemas/ExecutionLimitExceeded' '481': description: ExecutionAlreadyExists content: application/json: schema: $ref: '#/components/schemas/ExecutionAlreadyExists' '482': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '483': description: InvalidExecutionInput content: application/json: schema: $ref: '#/components/schemas/InvalidExecutionInput' '484': description: InvalidName content: application/json: schema: $ref: '#/components/schemas/InvalidName' '485': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' '486': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' '487': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartExecutionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.StartExecution summary: AWS Step Functions - Start Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.StartSyncExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartSyncExecution description: 'Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows. StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn''t reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. This API action isn''t logged in CloudTrail.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartSyncExecutionOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: InvalidExecutionInput content: application/json: schema: $ref: '#/components/schemas/InvalidExecutionInput' '482': description: InvalidName content: application/json: schema: $ref: '#/components/schemas/InvalidName' '483': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' '484': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' '485': description: StateMachineTypeNotSupported content: application/json: schema: $ref: '#/components/schemas/StateMachineTypeNotSupported' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartSyncExecutionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.StartSyncExecution summary: AWS Step Functions - Start Sync Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.StopExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopExecution description: 'Stops an execution. This API action is not supported by EXPRESS state machines.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopExecutionOutput' '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopExecutionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.StopExecution summary: AWS Step Functions - Stop Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.TagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: 'Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '482': description: TooManyTags content: application/json: schema: $ref: '#/components/schemas/TooManyTags' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.TagResource summary: AWS Step Functions - Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.UntagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UntagResource description: Remove a tag from a Step Functions resource responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.UntagResource summary: AWS Step Functions - Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.UpdateMapRun: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateMapRun description: Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMapRunOutput' '480': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateMapRunInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.UpdateMapRun summary: AWS Step Functions - Update Map Run x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions /#X-Amz-Target=AWSStepFunctions.UpdateStateMachine: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateStateMachine description: 'Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateStateMachineOutput' '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' '481': description: InvalidDefinition content: application/json: schema: $ref: '#/components/schemas/InvalidDefinition' '482': description: InvalidLoggingConfiguration content: application/json: schema: $ref: '#/components/schemas/InvalidLoggingConfiguration' '483': description: InvalidTracingConfiguration content: application/json: schema: $ref: '#/components/schemas/InvalidTracingConfiguration' '484': description: MissingRequiredParameter content: application/json: schema: $ref: '#/components/schemas/MissingRequiredParameter' '485': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' '486': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' '487': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateStateMachineInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.UpdateStateMachine summary: AWS Step Functions - Update State Machine x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - AWS Step Functions components: schemas: SendTaskSuccessOutput: type: object properties: {} ExecutionTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about the execution timeout that occurred during the execution. ActivityScheduleFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an activity schedule failure that occurred during an execution. CreateStateMachineOutput: type: object required: - stateMachineArn - creationDate properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the created state machine. creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the state machine is created. ListTagsForResourceOutput: type: object properties: tags: allOf: - $ref: '#/components/schemas/TagList' - description: An array of tags associated with the resource. ListStateMachinesOutput: type: object required: - stateMachines properties: stateMachines: $ref: '#/components/schemas/StateMachineList' nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. InvalidToken: {} DescribeActivityOutput: type: object required: - activityArn - name - creationDate properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the activity. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the activity is created. GetActivityTaskInput: type: object required: - activityArn title: GetActivityTaskInput properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.) workerName: allOf: - $ref: '#/components/schemas/Name' - description: You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history. UntagResourceInput: type: object required: - resourceArn - tagKeys title: UntagResourceInput properties: resourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) for the Step Functions state machine or activity. tagKeys: allOf: - $ref: '#/components/schemas/TagKeyList' - description: The list of tags to remove from the resource. TracingConfiguration: type: object properties: enabled: allOf: - $ref: '#/components/schemas/Enabled' - description: When set to true, X-Ray tracing is enabled. description: 'Selects whether or not the state machine''s X-Ray tracing is enabled. Default is false ' LambdaFunctionFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a Lambda function that failed during an execution. ActivityLimitExceeded: {} StateMachineLimitExceeded: {} LogLevel: type: string enum: - ALL - ERROR - FATAL - 'OFF' Tag: type: object properties: key: allOf: - $ref: '#/components/schemas/TagKey' - description: The key of a tag. value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value of a tag. description: '

Tags are key-value pairs that can be associated with Step Functions state machines and activities.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

' SendTaskHeartbeatInput: type: object required: - taskToken title: SendTaskHeartbeatInput properties: taskToken: allOf: - $ref: '#/components/schemas/TaskToken' - description: The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken. TaskStartedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. description: Contains details about the start of a task during an execution. LambdaFunctionScheduleFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a failed Lambda function schedule event that occurred during an execution. DeleteActivityOutput: type: object properties: {} Definition: type: string minLength: 1 maxLength: 1048576 format: password Name: type: string minLength: 1 maxLength: 80 TaskToken: type: string minLength: 1 maxLength: 1024 ValidationException: {} DescribeMapRunOutput: type: object required: - mapRunArn - executionArn - status - startDate - maxConcurrency - toleratedFailurePercentage - toleratedFailureCount - itemCounts - executionCounts properties: mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) that identifies a Map Run. executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started. status: allOf: - $ref: '#/components/schemas/MapRunStatus' - description: The current status of the Map Run. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when the Map Run was started. stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when the Map Run was stopped. maxConcurrency: allOf: - $ref: '#/components/schemas/MaxConcurrency' - description: The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time. toleratedFailurePercentage: allOf: - $ref: '#/components/schemas/ToleratedFailurePercentage' - description: The maximum percentage of failed child workflow executions before the Map Run fails. toleratedFailureCount: allOf: - $ref: '#/components/schemas/ToleratedFailureCount' - description: The maximum number of failed child workflow executions before the Map Run fails. itemCounts: allOf: - $ref: '#/components/schemas/MapRunItemCounts' - description: A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed. executionCounts: allOf: - $ref: '#/components/schemas/MapRunExecutionCounts' - description: A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded. LambdaFunctionTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about a Lambda function timeout that occurred during an execution. ExecutionStartedEventDetails: type: object properties: input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks. description: Contains details about the start of the execution. TagValue: type: string minLength: 0 maxLength: 256 ExecutionLimitExceeded: {} ActivityListItem: type: object required: - activityArn - name - creationDate properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the activity. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the activity is created. description: Contains details about an activity. ActivityTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about an activity timeout that occurred during an execution. InvalidLoggingConfiguration: {} ToleratedFailureCount: type: integer minimum: 0 MapRunExecutionCounts: type: object required: - pending - running - succeeded - failed - timedOut - aborted - total - resultsWritten properties: pending: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: 'The total number of child workflow executions that were started by a Map Run, but haven''t started executing yet. ' running: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of child workflow executions that were started by a Map Run and are currently in-progress. succeeded: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of child workflow executions that were started by a Map Run and have completed successfully. failed: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of child workflow executions that were started by a Map Run, but have failed. timedOut: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of child workflow executions that were started by a Map Run and have timed out. aborted: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: 'The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed. ' total: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of child workflow executions that were started by a Map Run. resultsWritten: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide. description: Contains details about all of the child workflow executions started by a Map Run. IncludeExecutionData: type: boolean StateMachineListItem: type: object required: - stateMachineArn - name - type - creationDate properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the state machine. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' type: allOf: - $ref: '#/components/schemas/StateMachineType' - description:

creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the state machine is created. description: Contains details about the state machine. PageSize: type: integer minimum: 0 maximum: 1000 Enabled: type: boolean MapRunListItem: type: object required: - executionArn - mapRunArn - stateMachineArn - startDate properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The executionArn of the execution from which the Map Run was started. mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of the Map Run. stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the executed state machine. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date on which the Map Run started. stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date on which the Map Run stopped. description: Contains details about a specific Map Run. ActivityWorkerLimitExceeded: {} DeleteStateMachineOutput: type: object properties: {} StopExecutionOutput: type: object required: - stopDate properties: stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution is stopped. ListActivitiesInput: type: object title: ListActivitiesInput properties: maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. MaxConcurrency: type: integer minimum: 0 ExecutionFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an execution failure event. GetActivityTaskOutput: type: object properties: taskToken: allOf: - $ref: '#/components/schemas/TaskToken' - description: A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task. input: allOf: - $ref: '#/components/schemas/SensitiveDataJobInput' - description: The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. ExecutionSucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about the successful termination of the execution. SensitiveCause: type: string minLength: 0 maxLength: 32768 format: password LogDestination: type: object properties: cloudWatchLogsLogGroup: allOf: - $ref: '#/components/schemas/CloudWatchLogsLogGroup' - description: An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide. description:

SyncExecutionStatus: type: string enum: - SUCCEEDED - FAILED - TIMED_OUT LambdaFunctionScheduledEventDetails: type: object required: - resource properties: resource: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the scheduled Lambda function. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about input for an execution history event. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the Lambda function. taskCredentials: allOf: - $ref: '#/components/schemas/TaskCredentials' - description: The credentials that Step Functions uses for the task. description: Contains details about a Lambda function scheduled during an execution. MapRunList: type: array items: $ref: '#/components/schemas/MapRunListItem' TaskTimedOut: {} ActivityDoesNotExist: {} StopExecutionInput: type: object required: - executionArn title: StopExecutionInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution to stop. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. DescribeStateMachineForExecutionInput: type: object required: - executionArn title: DescribeStateMachineForExecutionInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution you want state machine information for. SensitiveError: type: string minLength: 0 maxLength: 256 format: password InvalidOutput: {} MissingRequiredParameter: {} HistoryEventType: type: string enum: - ActivityFailed - ActivityScheduled - ActivityScheduleFailed - ActivityStarted - ActivitySucceeded - ActivityTimedOut - ChoiceStateEntered - ChoiceStateExited - ExecutionAborted - ExecutionFailed - ExecutionStarted - ExecutionSucceeded - ExecutionTimedOut - FailStateEntered - LambdaFunctionFailed - LambdaFunctionScheduled - LambdaFunctionScheduleFailed - LambdaFunctionStarted - LambdaFunctionStartFailed - LambdaFunctionSucceeded - LambdaFunctionTimedOut - MapIterationAborted - MapIterationFailed - MapIterationStarted - MapIterationSucceeded - MapStateAborted - MapStateEntered - MapStateExited - MapStateFailed - MapStateStarted - MapStateSucceeded - ParallelStateAborted - ParallelStateEntered - ParallelStateExited - ParallelStateFailed - ParallelStateStarted - ParallelStateSucceeded - PassStateEntered - PassStateExited - SucceedStateEntered - SucceedStateExited - TaskFailed - TaskScheduled - TaskStarted - TaskStartFailed - TaskStateAborted - TaskStateEntered - TaskStateExited - TaskSubmitFailed - TaskSubmitted - TaskSucceeded - TaskTimedOut - WaitStateAborted - WaitStateEntered - WaitStateExited - MapRunAborted - MapRunFailed - MapRunStarted - MapRunSucceeded UntagResourceOutput: type: object properties: {} SendTaskSuccessInput: type: object required: - taskToken - output title: SendTaskSuccessInput properties: taskToken: allOf: - $ref: '#/components/schemas/TaskToken' - description: The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken. output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. MapIterationEventDetails: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the iteration’s parent Map state. index: allOf: - $ref: '#/components/schemas/UnsignedInteger' - description: The index of the array belonging to the Map state iteration. description: Contains details about an iteration of a Map state. StateMachineList: type: array items: $ref: '#/components/schemas/StateMachineListItem' StateMachineStatus: type: string enum: - ACTIVE - DELETING TraceHeader: type: string pattern: \p{ASCII}* minLength: 0 maxLength: 256 HistoryEvent: type: object required: - timestamp - type - id properties: timestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time the event occurred. type: allOf: - $ref: '#/components/schemas/HistoryEventType' - description: The type of the event. id: allOf: - $ref: '#/components/schemas/EventId' - description: The id of the event. Events are numbered sequentially, starting at one. previousEventId: allOf: - $ref: '#/components/schemas/EventId' - description: The id of the previous event. activityFailedEventDetails: $ref: '#/components/schemas/ActivityFailedEventDetails' activityScheduleFailedEventDetails: allOf: - $ref: '#/components/schemas/ActivityScheduleFailedEventDetails' - description: Contains details about an activity schedule event that failed during an execution. activityScheduledEventDetails: $ref: '#/components/schemas/ActivityScheduledEventDetails' activityStartedEventDetails: $ref: '#/components/schemas/ActivityStartedEventDetails' activitySucceededEventDetails: $ref: '#/components/schemas/ActivitySucceededEventDetails' activityTimedOutEventDetails: $ref: '#/components/schemas/ActivityTimedOutEventDetails' taskFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskFailedEventDetails' - description: Contains details about the failure of a task. taskScheduledEventDetails: allOf: - $ref: '#/components/schemas/TaskScheduledEventDetails' - description: Contains details about a task that was scheduled. taskStartFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskStartFailedEventDetails' - description: Contains details about a task that failed to start. taskStartedEventDetails: allOf: - $ref: '#/components/schemas/TaskStartedEventDetails' - description: Contains details about a task that was started. taskSubmitFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskSubmitFailedEventDetails' - description: Contains details about a task that where the submit failed. taskSubmittedEventDetails: allOf: - $ref: '#/components/schemas/TaskSubmittedEventDetails' - description: Contains details about a submitted task. taskSucceededEventDetails: allOf: - $ref: '#/components/schemas/TaskSucceededEventDetails' - description: Contains details about a task that succeeded. taskTimedOutEventDetails: allOf: - $ref: '#/components/schemas/TaskTimedOutEventDetails' - description: Contains details about a task that timed out. executionFailedEventDetails: $ref: '#/components/schemas/ExecutionFailedEventDetails' executionStartedEventDetails: $ref: '#/components/schemas/ExecutionStartedEventDetails' executionSucceededEventDetails: $ref: '#/components/schemas/ExecutionSucceededEventDetails' executionAbortedEventDetails: $ref: '#/components/schemas/ExecutionAbortedEventDetails' executionTimedOutEventDetails: $ref: '#/components/schemas/ExecutionTimedOutEventDetails' mapStateStartedEventDetails: allOf: - $ref: '#/components/schemas/MapStateStartedEventDetails' - description: Contains details about Map state that was started. mapIterationStartedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that was started. mapIterationSucceededEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that succeeded. mapIterationFailedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that failed. mapIterationAbortedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that was aborted. lambdaFunctionFailedEventDetails: $ref: '#/components/schemas/LambdaFunctionFailedEventDetails' lambdaFunctionScheduleFailedEventDetails: $ref: '#/components/schemas/LambdaFunctionScheduleFailedEventDetails' lambdaFunctionScheduledEventDetails: $ref: '#/components/schemas/LambdaFunctionScheduledEventDetails' lambdaFunctionStartFailedEventDetails: allOf: - $ref: '#/components/schemas/LambdaFunctionStartFailedEventDetails' - description: Contains details about a lambda function that failed to start during an execution. lambdaFunctionSucceededEventDetails: allOf: - $ref: '#/components/schemas/LambdaFunctionSucceededEventDetails' - description: Contains details about a Lambda function that terminated successfully during an execution. lambdaFunctionTimedOutEventDetails: $ref: '#/components/schemas/LambdaFunctionTimedOutEventDetails' stateEnteredEventDetails: $ref: '#/components/schemas/StateEnteredEventDetails' stateExitedEventDetails: $ref: '#/components/schemas/StateExitedEventDetails' mapRunStartedEventDetails: allOf: - $ref: '#/components/schemas/MapRunStartedEventDetails' - description: Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started. mapRunFailedEventDetails: allOf: - $ref: '#/components/schemas/MapRunFailedEventDetails' - description: Contains error and cause details about a Map Run that failed. description: Contains details about the events of an execution. TooManyTags: {} ToleratedFailurePercentage: type: number format: float minimum: 0 maximum: 100 LongArn: type: string minLength: 1 maxLength: 2000 ActivityList: type: array items: $ref: '#/components/schemas/ActivityListItem' MapRunFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the Map Run failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a Map Run failure event that occurred during a state machine execution. ResourceNotFound: {} InvalidExecutionInput: {} DescribeStateMachineForExecutionOutput: type: object required: - stateMachineArn - name - definition - roleArn - updateDate properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine associated with the execution. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the state machine associated with the execution. definition: allOf: - $ref: '#/components/schemas/Definition' - description: The Amazon States Language definition of the state machine. See Amazon States Language. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: 'The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. ' updateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date. loggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' tracingConfiguration: allOf: - $ref: '#/components/schemas/TracingConfiguration' - description: Selects whether X-Ray tracing is enabled. mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state. label: allOf: - $ref: '#/components/schemas/MapRunLabel' - description: A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state. ListActivitiesOutput: type: object required: - activities properties: activities: allOf: - $ref: '#/components/schemas/ActivityList' - description: The list of activities. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. GetExecutionHistoryOutput: type: object required: - events properties: events: allOf: - $ref: '#/components/schemas/HistoryEventList' - description: The list of events that occurred in the execution. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. StartExecutionOutput: type: object required: - executionArn - startDate properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the execution. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution is started. DescribeExecutionInput: type: object required: - executionArn title: DescribeExecutionInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution to describe. HistoryEventExecutionDataDetails: type: object properties: truncated: allOf: - $ref: '#/components/schemas/truncated' - description: Indicates whether input or output was truncated in the response. Always false for API calls. description: Provides details about input or output in an execution history event. DeleteStateMachineInput: type: object required: - stateMachineArn title: DeleteStateMachineInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine to delete. MapStateStartedEventDetails: type: object properties: length: allOf: - $ref: '#/components/schemas/UnsignedInteger' - description: The size of the array for Map state iterations. description: Details about a Map state that was started. StartSyncExecutionInput: type: object required: - stateMachineArn title: StartSyncExecutionInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine to execute. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the execution. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: '

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don''t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

' traceHeader: allOf: - $ref: '#/components/schemas/TraceHeader' - description: Passes the X-Ray trace header. The trace header can also be passed in the request payload. ListMapRunsOutput: type: object required: - mapRuns properties: mapRuns: allOf: - $ref: '#/components/schemas/MapRunList' - description: An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. DescribeExecutionOutput: type: object required: - executionArn - stateMachineArn - status - startDate properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the execution. stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the executed stated machine. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' status: allOf: - $ref: '#/components/schemas/ExecutionStatus' - description: The current status of the execution. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution is started. stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: If the execution has already ended, the date the execution stopped. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails' output: allOf: - $ref: '#/components/schemas/SensitiveData' - description:

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

 outputDetails: $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails' traceHeader: allOf: - $ref: '#/components/schemas/TraceHeader' - description: The X-Ray trace header that was passed to the execution. mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error string if the state machine execution failed. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: The cause string if the state machine execution failed. TaskSucceededEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about the successful completion of a task state. BilledMemoryUsed: type: integer minimum: 0 CreateActivityOutput: type: object required: - activityArn - creationDate properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the created activity. creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the activity is created. DescribeActivityInput: type: object required: - activityArn title: DescribeActivityInput properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the activity to describe. MapRunStatus: type: string enum: - RUNNING - SUCCEEDED - FAILED - ABORTED TaskDoesNotExist: {} TaskCredentials: type: object properties: roleArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources. description: Contains details about the credentials that Step Functions uses for a task. TagResourceInput: type: object required: - resourceArn - tags title: TagResourceInput properties: resourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) for the Step Functions state machine or activity. tags: allOf: - $ref: '#/components/schemas/TagList' - description: '

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

' ActivitySucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about an activity that successfully terminated during an execution. StartExecutionInput: type: object required: - stateMachineArn title: StartExecutionInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine to execute. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: '

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don''t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

' traceHeader: allOf: - $ref: '#/components/schemas/TraceHeader' - description: Passes the X-Ray trace header. The trace header can also be passed in the request payload. DescribeMapRunInput: type: object required: - mapRunArn title: DescribeMapRunInput properties: mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) that identifies a Map Run. SendTaskHeartbeatOutput: type: object properties: {} StateEnteredEventDetails: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the state. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. description: Contains details about a state entered during an execution. Identity: type: string maxLength: 256 TaskFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task failure event. Timestamp: type: string format: date-time StartSyncExecutionOutput: type: object required: - executionArn - startDate - stopDate - status properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the execution. stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the state machine. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the execution. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution is started. stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: If the execution has already ended, the date the execution stopped. status: allOf: - $ref: '#/components/schemas/SyncExecutionStatus' - description: The current status of the execution. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails' output: allOf: - $ref: '#/components/schemas/SensitiveData' - description:

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

 outputDetails: $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails' traceHeader: allOf: - $ref: '#/components/schemas/TraceHeader' - description: The X-Ray trace header that was passed to the execution. billingDetails: allOf: - $ref: '#/components/schemas/BillingDetails' - description: An object that describes workflow billing details, including billed duration and memory use. BilledDuration: type: integer minimum: 0 LogDestinationList: type: array items: $ref: '#/components/schemas/LogDestination' StateMachineAlreadyExists: {} UpdateStateMachineInput: type: object required: - stateMachineArn title: UpdateStateMachineInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine. definition: allOf: - $ref: '#/components/schemas/Definition' - description: The Amazon States Language definition of the state machine. See Amazon States Language. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the IAM role of the state machine. loggingConfiguration: allOf: - $ref: '#/components/schemas/LoggingConfiguration' - description: The LoggingConfiguration data type is used to set CloudWatch Logs options. tracingConfiguration: allOf: - $ref: '#/components/schemas/TracingConfiguration' - description: Selects whether X-Ray tracing is enabled. InvalidDefinition: {} SensitiveDataJobInput: type: string maxLength: 262144 format: password SendTaskFailureOutput: type: object properties: {} InvalidTracingConfiguration: {} HistoryEventList: type: array description: Contains details about the events that occurred during an execution. items: $ref: '#/components/schemas/HistoryEvent' GetExecutionHistoryInput: type: object required: - executionArn title: GetExecutionHistoryInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

reverseOrder: allOf: - $ref: '#/components/schemas/ReverseOrder' - description: Lists events in descending order of their timeStamp. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. includeExecutionData: allOf: - $ref: '#/components/schemas/IncludeExecutionDataGetExecutionHistory' - description: You can select whether execution data (input or output of a history event) is returned. The default is true. ExecutionAlreadyExists: {} InvalidArn: {} TaskStartFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task that failed to start during an execution. LambdaFunctionSucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about a Lambda function that successfully terminated during an execution. TagKey: type: string minLength: 1 maxLength: 128 StateExitedEventDetails: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the state.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about an exit from a state during an execution. includedDetails: type: boolean TaskSubmittedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about a task submitted to a resource . UpdateStateMachineOutput: type: object required: - updateDate properties: updateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time the state machine was updated. EventId: type: integer TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' CloudWatchLogsLogGroup: type: object properties: logGroupArn: allOf: - $ref: '#/components/schemas/Arn' - description: 'The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :* ' description:

UpdateMapRunOutput: type: object properties: {} ListExecutionsInput: type: object title: ListExecutionsInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description:

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

statusFilter: allOf: - $ref: '#/components/schemas/ExecutionStatus' - description: If specified, only list the executions whose current execution status matches the given filter. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken: allOf: - $ref: '#/components/schemas/ListExecutionsPageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description:

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

SensitiveData: type: string maxLength: 262144 format: password ExecutionAbortedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an abort of an execution. ListExecutionsOutput: type: object required: - executions properties: executions: allOf: - $ref: '#/components/schemas/ExecutionList' - description: The list of matching executions. nextToken: allOf: - $ref: '#/components/schemas/ListExecutionsPageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. MapRunStartedEventDetails: type: object properties: mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of a Map Run that was started. description: Contains details about a Map Run that was started during a state machine execution. ConnectorParameters: type: string minLength: 0 maxLength: 262144 format: password ListTagsForResourceInput: type: object required: - resourceArn title: ListTagsForResourceInput properties: resourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) for the Step Functions state machine or activity. CreateStateMachineInput: type: object required: - name - definition - roleArn title: CreateStateMachineInput properties: name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' definition: allOf: - $ref: '#/components/schemas/Definition' - description: The Amazon States Language definition of the state machine. See Amazon States Language. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the IAM role to use for this state machine. type: allOf: - $ref: '#/components/schemas/StateMachineType' - description: Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. loggingConfiguration: allOf: - $ref: '#/components/schemas/LoggingConfiguration' - description:

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

 tags: allOf: - $ref: '#/components/schemas/TagList' - description: '

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

' tracingConfiguration: allOf: - $ref: '#/components/schemas/TracingConfiguration' - description: Selects whether X-Ray tracing is enabled. TagList: type: array items: $ref: '#/components/schemas/Tag' ExecutionDoesNotExist: {} DescribeStateMachineInput: type: object required: - stateMachineArn title: DescribeStateMachineInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine to describe. PageToken: type: string minLength: 1 maxLength: 1024 StateMachineTypeNotSupported: {} UpdateMapRunInput: type: object required: - mapRunArn title: UpdateMapRunInput properties: mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of a Map Run. maxConcurrency: allOf: - $ref: '#/components/schemas/MaxConcurrency' - description: The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time. toleratedFailurePercentage: allOf: - $ref: '#/components/schemas/ToleratedFailurePercentage' - description: The maximum percentage of failed items before the Map Run fails. toleratedFailureCount: allOf: - $ref: '#/components/schemas/ToleratedFailureCount' - description: The maximum number of failed items before the Map Run fails. SendTaskFailureInput: type: object required: - taskToken title: SendTaskFailureInput properties: taskToken: allOf: - $ref: '#/components/schemas/TaskToken' - description: The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. StateMachineDeleting: {} TaskSubmitFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task that failed to submit during an execution. DeleteActivityInput: type: object required: - activityArn title: DeleteActivityInput properties: activityArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the activity to delete. CreateActivityInput: type: object required: - name title: CreateActivityInput properties: name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' tags: allOf: - $ref: '#/components/schemas/TagList' - description: '

The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

' ExecutionListItem: type: object required: - executionArn - stateMachineArn - name - status - startDate properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the execution. stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the executed state machine. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' status: allOf: - $ref: '#/components/schemas/ExecutionStatus' - description: The current status of the execution. startDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution started. stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: If the execution already ended, the date the execution stopped. mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned. itemCount: allOf: - $ref: '#/components/schemas/UnsignedInteger' - description: The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned. description: Contains details about an execution. ReverseOrder: type: boolean StateMachineType: type: string enum: - STANDARD - EXPRESS MapRunLabel: type: string TaskTimedOutEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a resource timeout that occurred during an execution. ExecutionStatus: type: string enum: - RUNNING - SUCCEEDED - FAILED - TIMED_OUT - ABORTED DescribeStateMachineOutput: type: object required: - stateMachineArn - name - definition - roleArn - type - creationDate properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies the state machine. name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' status: allOf: - $ref: '#/components/schemas/StateMachineStatus' - description: The current status of the state machine. definition: allOf: - $ref: '#/components/schemas/Definition' - description: The Amazon States Language definition of the state machine. See Amazon States Language. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.) type: allOf: - $ref: '#/components/schemas/StateMachineType' - description: The type of the state machine (STANDARD or EXPRESS). creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the state machine is created. loggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' tracingConfiguration: allOf: - $ref: '#/components/schemas/TracingConfiguration' - description: Selects whether X-Ray tracing is enabled. label: allOf: - $ref: '#/components/schemas/MapRunLabel' - description: A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN. UnsignedLong: type: integer minimum: 0 TaskScheduledEventDetails: type: object required: - resourceType - resource - region - parameters properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. region: allOf: - $ref: '#/components/schemas/Name' - description: The region of the scheduled task parameters: allOf: - $ref: '#/components/schemas/ConnectorParameters' - description: The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the task. heartbeatInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration between two heartbeats for the task. taskCredentials: allOf: - $ref: '#/components/schemas/TaskCredentials' - description: The credentials that Step Functions uses for the task. description: Contains details about a task scheduled during an execution. ActivityFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an activity that failed during an execution. ListMapRunsInput: type: object required: - executionArn title: ListMapRunsInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. ActivityStartedEventDetails: type: object properties: workerName: allOf: - $ref: '#/components/schemas/Identity' - description: The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask. description: Contains details about the start of an activity during an execution. ListStateMachinesInput: type: object title: ListStateMachinesInput properties: maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. ActivityScheduledEventDetails: type: object required: - resource properties: resource: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the scheduled activity. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the activity task. heartbeatInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration between two heartbeats for the activity task. description: Contains details about an activity scheduled during an execution. InvalidName: {} MapRunItemCounts: type: object required: - pending - running - succeeded - failed - timedOut - aborted - total - resultsWritten properties: pending: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items to process in child workflow executions that haven't started running yet. running: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items being processed in child workflow executions that are currently in-progress. succeeded: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items processed in child workflow executions that have completed successfully. failed: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items processed in child workflow executions that have failed. timedOut: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items processed in child workflow executions that have timed out. aborted: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed. total: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: The total number of items processed in all the child workflow executions started by a Map Run. resultsWritten: allOf: - $ref: '#/components/schemas/UnsignedLong' - description: Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide. description: Contains details about items that were processed in all of the child workflow executions that were started by a Map Run. TagResourceOutput: type: object properties: {} CloudWatchEventsExecutionDataDetails: type: object properties: included: allOf: - $ref: '#/components/schemas/includedDetails' - description: 'Indicates whether input or output was included in the response. Always true for API calls. ' description: Provides details about execution input or output. truncated: type: boolean LambdaFunctionStartFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a lambda function that failed to start during an execution. StateMachineDoesNotExist: {} ListExecutionsPageToken: type: string minLength: 1 maxLength: 3096 TimeoutInSeconds: type: integer ExecutionList: type: array items: $ref: '#/components/schemas/ExecutionListItem' LoggingConfiguration: type: object properties: level: allOf: - $ref: '#/components/schemas/LogLevel' - description: Defines which category of execution history events are logged. includeExecutionData: allOf: - $ref: '#/components/schemas/IncludeExecutionData' - description: Determines whether execution data is included in your log. When set to false, data is excluded. destinations: allOf: - $ref: '#/components/schemas/LogDestinationList' - description: An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF. description: The LoggingConfiguration data type is used to set CloudWatch Logs options. BillingDetails: type: object properties: billedMemoryUsedInMB: allOf: - $ref: '#/components/schemas/BilledMemoryUsed' - description: Billed memory consumption of your workflow, in MB. billedDurationInMilliseconds: allOf: - $ref: '#/components/schemas/BilledDuration' - description: Billed duration of your workflow, in milliseconds. description: An object that describes workflow billing details. Arn: type: string minLength: 1 maxLength: 256 IncludeExecutionDataGetExecutionHistory: type: boolean UnsignedInteger: type: integer minimum: 0 parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/states/ x-hasEquivalentPaths: true