Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' 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 externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/states/' 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=AWSStepFunctions.CreateActivity: 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.
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.
If you set the publish parameter of this API action to true, it publishes version 1 as the first
revision of the state machine.
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. The check is also based on the publish and versionDescription
parameters. 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.
Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client''s code.
You can also
map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration
parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs
a given execution based on the percentage you specify.
To create an alias that points to a single version, specify a single RoutingConfig object with a weight set
to 100.
You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters.
Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateStateMachineAliasOutput' examples: CreateStateMachineAlias200Example: summary: Default CreateStateMachineAlias 200 x-microcks-default: true value: stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example creationDate: example-value '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: CreateStateMachineAlias480Example: summary: Default CreateStateMachineAlias 480 x-microcks-default: true value: example-value '481': description: InvalidName content: application/json: schema: $ref: '#/components/schemas/InvalidName' examples: CreateStateMachineAlias481Example: summary: Default CreateStateMachineAlias 481 x-microcks-default: true value: example-value '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CreateStateMachineAlias482Example: summary: Default CreateStateMachineAlias 482 x-microcks-default: true value: example-value '483': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' examples: CreateStateMachineAlias483Example: summary: Default CreateStateMachineAlias 483 x-microcks-default: true value: example-value '484': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: CreateStateMachineAlias484Example: summary: Default CreateStateMachineAlias 484 x-microcks-default: true value: example-value '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateStateMachineAlias485Example: summary: Default CreateStateMachineAlias 485 x-microcks-default: true value: example-value '486': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: CreateStateMachineAlias486Example: summary: Default CreateStateMachineAlias 486 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateStateMachineAliasInput' examples: CreateStateMachineAliasRequestExample: summary: Default CreateStateMachineAlias request x-microcks-default: true value: description: example-value name: MyResource routingConfiguration: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.CreateStateMachineAlias summary: Amazon Create State Machine Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.DeleteActivity: post: operationId: DeleteActivity description: Deletes an activity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteActivityOutput' examples: DeleteActivity200Example: summary: Default DeleteActivity 200 x-microcks-default: true value: {} '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: DeleteActivity480Example: summary: Default DeleteActivity 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteActivityInput' examples: DeleteActivityRequestExample: summary: Default DeleteActivity request x-microcks-default: true value: activityArn: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DeleteActivity summary: Amazon Delete Activity x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.DeleteStateMachine: 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.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map
state, the request fails with ValidationException.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For EXPRESS state machines,
the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Deletes a state machine alias.
After you delete a state machine alias, you can''t use it to start executions. When you delete a state machine alias, Step Functions doesn''t delete the state machine versions that alias references.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineAliasOutput' examples: DeleteStateMachineAlias200Example: summary: Default DeleteStateMachineAlias 200 x-microcks-default: true value: {} '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeleteStateMachineAlias480Example: summary: Default DeleteStateMachineAlias 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: DeleteStateMachineAlias481Example: summary: Default DeleteStateMachineAlias 481 x-microcks-default: true value: example-value '482': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: DeleteStateMachineAlias482Example: summary: Default DeleteStateMachineAlias 482 x-microcks-default: true value: example-value '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeleteStateMachineAlias483Example: summary: Default DeleteStateMachineAlias 483 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineAliasInput' examples: DeleteStateMachineAliasRequestExample: summary: Default DeleteStateMachineAlias request x-microcks-default: true value: stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DeleteStateMachineAlias summary: Amazon Delete State Machine Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.DeleteStateMachineVersion: post: operationId: DeleteStateMachineVersion description: 'Deletes a state machine version. After you delete a version, you can''t call StartExecution using that version''s ARN or use the version with a state machine alias.
Deleting a state machine version won''t terminate its in-progress executions.
You can''t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineVersionOutput' examples: DeleteStateMachineVersion200Example: summary: Default DeleteStateMachineVersion 200 x-microcks-default: true value: {} '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeleteStateMachineVersion480Example: summary: Default DeleteStateMachineVersion 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: DeleteStateMachineVersion481Example: summary: Default DeleteStateMachineVersion 481 x-microcks-default: true value: example-value '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeleteStateMachineVersion482Example: summary: Default DeleteStateMachineVersion 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteStateMachineVersionInput' examples: DeleteStateMachineVersionRequestExample: summary: Default DeleteStateMachineVersion request x-microcks-default: true value: stateMachineVersionArn: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DeleteStateMachineVersion summary: Amazon Delete State Machine Version x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.DescribeActivity: 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.
Provides 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 Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution
API action, DescribeExecution returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS state machinearen''t supported by DescribeExecution unless a Map Run dispatched them.
Provides information about a state machine''s definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following
qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The
following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Returns details about a state machine alias.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineAliasOutput' examples: DescribeStateMachineAlias200Example: summary: Default DescribeStateMachineAlias 200 x-microcks-default: true value: stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example name: MyResource description: example-value routingConfiguration: example-value creationDate: example-value updateDate: example-value '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DescribeStateMachineAlias480Example: summary: Default DescribeStateMachineAlias 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: DescribeStateMachineAlias481Example: summary: Default DescribeStateMachineAlias 481 x-microcks-default: true value: example-value '482': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: DescribeStateMachineAlias482Example: summary: Default DescribeStateMachineAlias 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeStateMachineAliasInput' examples: DescribeStateMachineAliasRequestExample: summary: Default DescribeStateMachineAlias request x-microcks-default: true value: stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.DescribeStateMachineAlias summary: Amazon Describe State Machine Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecution: post: operationId: DescribeStateMachineForExecution description: 'Provides information about a state machine''s definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is 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.
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.
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.
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.
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.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
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.
DescribeMapRun to obtain more information,
if needed.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMapRunsOutput'
examples:
ListMapRuns200Example:
summary: Default ListMapRuns 200
x-microcks-default: true
value:
mapRuns: example-value
nextToken: example-value
'480':
description: ExecutionDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionDoesNotExist'
examples:
ListMapRuns480Example:
summary: Default ListMapRuns 480
x-microcks-default: true
value: example-value
'481':
description: InvalidArn
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArn'
examples:
ListMapRuns481Example:
summary: Default ListMapRuns 481
x-microcks-default: true
value: example-value
'482':
description: InvalidToken
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidToken'
examples:
ListMapRuns482Example:
summary: Default ListMapRuns 482
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMapRunsInput'
examples:
ListMapRunsRequestExample:
summary: Default ListMapRuns request
x-microcks-default: true
value:
executionArn: arn:aws:service:us-east-1:123456789012:resource/example
maxResults: example-value
nextToken: example-value
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: Amazon List Map Runs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSStepFunctions.ListStateMachineAliases:
post:
operationId: ListStateMachineAliases
description: 'Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version,
you can specify the version ARN in the stateMachineArn parameter.
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.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListStateMachineAliasesOutput' examples: ListStateMachineAliases200Example: summary: Default ListStateMachineAliases 200 x-microcks-default: true value: stateMachineAliases: example-value nextToken: example-value '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: ListStateMachineAliases480Example: summary: Default ListStateMachineAliases 480 x-microcks-default: true value: example-value '481': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' examples: ListStateMachineAliases481Example: summary: Default ListStateMachineAliases 481 x-microcks-default: true value: example-value '482': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: ListStateMachineAliases482Example: summary: Default ListStateMachineAliases 482 x-microcks-default: true value: example-value '483': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' examples: ListStateMachineAliases483Example: summary: Default ListStateMachineAliases 483 x-microcks-default: true value: example-value '484': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' examples: ListStateMachineAliases484Example: summary: Default ListStateMachineAliases 484 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListStateMachineAliasesInput' examples: ListStateMachineAliasesRequestExample: summary: Default ListStateMachineAliases request x-microcks-default: true value: stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example nextToken: example-value maxResults: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListStateMachineAliases summary: Amazon List State Machine Aliases x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.ListStateMachineVersions: post: operationId: ListStateMachineVersions description: 'Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
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.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListStateMachineVersionsOutput' examples: ListStateMachineVersions200Example: summary: Default ListStateMachineVersions 200 x-microcks-default: true value: stateMachineVersions: example-value nextToken: example-value '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListStateMachineVersions480Example: summary: Default ListStateMachineVersions 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: ListStateMachineVersions481Example: summary: Default ListStateMachineVersions 481 x-microcks-default: true value: example-value '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' examples: ListStateMachineVersions482Example: summary: Default ListStateMachineVersions 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListStateMachineVersionsInput' examples: ListStateMachineVersionsRequestExample: summary: Default ListStateMachineVersions request x-microcks-default: true value: stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example nextToken: example-value maxResults: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListStateMachineVersions summary: Amazon List State Machine Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.ListStateMachines: 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.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion
is an idempotent API. It doesn''t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion''s idempotency
check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don''t specify
a revisionId, Step Functions checks for a previously published version of the state machine''s current revision.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PublishStateMachineVersionOutput' examples: PublishStateMachineVersion200Example: summary: Default PublishStateMachineVersion 200 x-microcks-default: true value: creationDate: example-value stateMachineVersionArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: PublishStateMachineVersion480Example: summary: Default PublishStateMachineVersion 480 x-microcks-default: true value: example-value '481': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' examples: PublishStateMachineVersion481Example: summary: Default PublishStateMachineVersion 481 x-microcks-default: true value: example-value '482': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' examples: PublishStateMachineVersion482Example: summary: Default PublishStateMachineVersion 482 x-microcks-default: true value: example-value '483': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: PublishStateMachineVersion483Example: summary: Default PublishStateMachineVersion 483 x-microcks-default: true value: example-value '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: PublishStateMachineVersion484Example: summary: Default PublishStateMachineVersion 484 x-microcks-default: true value: example-value '485': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: PublishStateMachineVersion485Example: summary: Default PublishStateMachineVersion 485 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublishStateMachineVersionInput' examples: PublishStateMachineVersionRequestExample: summary: Default PublishStateMachineVersion request x-microcks-default: true value: stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example revisionId: example-value description: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.PublishStateMachineVersion summary: Amazon Publish State Machine Version x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=AWSStepFunctions.SendTaskFailure: post: operationId: SendTaskFailure description: 'Used by activity workers and task states using the callback pattern to report that the task identified by thetaskToken failed.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskFailureOutput'
examples:
SendTaskFailure200Example:
summary: Default SendTaskFailure 200
x-microcks-default: true
value: {}
'480':
description: TaskDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/TaskDoesNotExist'
examples:
SendTaskFailure480Example:
summary: Default SendTaskFailure 480
x-microcks-default: true
value: example-value
'481':
description: InvalidToken
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidToken'
examples:
SendTaskFailure481Example:
summary: Default SendTaskFailure 481
x-microcks-default: true
value: example-value
'482':
description: TaskTimedOut
content:
application/json:
schema:
$ref: '#/components/schemas/TaskTimedOut'
examples:
SendTaskFailure482Example:
summary: Default SendTaskFailure 482
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskFailureInput'
examples:
SendTaskFailureRequestExample:
summary: Default SendTaskFailure request
x-microcks-default: true
value:
taskToken: example-value
error: example-value
cause: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.SendTaskFailure
summary: Amazon Send Task Failure
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSStepFunctions.SendTaskHeartbeat:
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.
taskToken completed successfully.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskSuccessOutput'
examples:
SendTaskSuccess200Example:
summary: Default SendTaskSuccess 200
x-microcks-default: true
value: {}
'480':
description: TaskDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/TaskDoesNotExist'
examples:
SendTaskSuccess480Example:
summary: Default SendTaskSuccess 480
x-microcks-default: true
value: example-value
'481':
description: InvalidOutput
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidOutput'
examples:
SendTaskSuccess481Example:
summary: Default SendTaskSuccess 481
x-microcks-default: true
value: example-value
'482':
description: InvalidToken
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidToken'
examples:
SendTaskSuccess482Example:
summary: Default SendTaskSuccess 482
x-microcks-default: true
value: example-value
'483':
description: TaskTimedOut
content:
application/json:
schema:
$ref: '#/components/schemas/TaskTimedOut'
examples:
SendTaskSuccess483Example:
summary: Default SendTaskSuccess 483
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskSuccessInput'
examples:
SendTaskSuccessRequestExample:
summary: Default SendTaskSuccess request
x-microcks-default: true
value:
taskToken: example-value
output: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.SendTaskSuccess
summary: Amazon Send Task Success
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=AWSStepFunctions.StartExecution:
post:
operationId: StartExecution
description: 'Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with
a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The following
qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of
a state machine version, call StartExecution and provide the version ARN or the
ARN of an alias that points to the version.
StartExecution is idempotent
for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return
the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.
StartExecution isn''t idempotent for EXPRESS workflows.
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.
Stops an execution.
This API action is not supported by EXPRESS state machines.
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: _ . : / = + - @.
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.
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.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The
following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the publish parameter to true in the same action to publish a new version.
This way, you can opt-in to strict versioning of your state machine.
Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call
UpdateStateMachine may use the previous state machine definition and roleArn.
Updates the configuration of an existing state machine alias by modifying its
description or routingConfiguration.
You must specify at least one of the description or routingConfiguration parameters to update a state
machine alias.
UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description,
and routingConfiguration parameters. Requests with the same parameters return an idempotent response.
This operation is eventually consistent. All StartExecution
requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.
Related operations:
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateStateMachineAliasOutput' examples: UpdateStateMachineAlias200Example: summary: Default UpdateStateMachineAlias 200 x-microcks-default: true value: updateDate: example-value '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdateStateMachineAlias480Example: summary: Default UpdateStateMachineAlias 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: UpdateStateMachineAlias481Example: summary: Default UpdateStateMachineAlias 481 x-microcks-default: true value: example-value '482': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: UpdateStateMachineAlias482Example: summary: Default UpdateStateMachineAlias 482 x-microcks-default: true value: example-value '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateStateMachineAlias483Example: summary: Default UpdateStateMachineAlias 483 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateStateMachineAliasInput' examples: UpdateStateMachineAliasRequestExample: summary: Default UpdateStateMachineAlias request x-microcks-default: true value: stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example description: example-value routingConfiguration: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.UpdateStateMachineAlias summary: Amazon Update State Machine Alias x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date 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-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: 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. 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:
white space
brackets
< > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control
characters (U+0000-001F, U+007F-009F)
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: _ . : / = + - @.
publish parameter to true, this field returns
null value.'
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:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F,
U+007F-009F)
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 isSTANDARD. 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 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: _ . : / = + - @.
true to publish the first version of the state machine during creation. The default is false.
versionDescription:
allOf:
- $ref: '#/components/schemas/VersionDescription'
- description: 'Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription,
but publish to false, this API action throws ValidationException.'
InvalidArn: {}
InvalidDefinition: {}
InvalidLoggingConfiguration: {}
InvalidTracingConfiguration: {}
StateMachineAlreadyExists: {}
StateMachineDeleting: {}
StateMachineLimitExceeded: {}
StateMachineTypeNotSupported: {}
ValidationException: {}
ConflictException: {}
CreateStateMachineAliasOutput:
type: object
required:
- stateMachineAliasArn
- creationDate
properties:
stateMachineAliasArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) that identifies the created state machine alias.
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the state machine alias was created.
CreateStateMachineAliasInput:
type: object
required:
- name
- routingConfiguration
title: CreateStateMachineAliasInput
properties:
description:
allOf:
- $ref: '#/components/schemas/AliasDescription'
- description: A description for the state machine alias.
name:
allOf:
- $ref: '#/components/schemas/CharacterRestrictedName'
- description: 'The name of the state machine alias.
To avoid conflict with version ARNs, don''t use an integer in the name of the alias.
' routingConfiguration: allOf: - $ref: '#/components/schemas/RoutingConfigurationList' - description: The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions.routingConfiguration
contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on
the weight assigned to each RoutingConfig.
ResourceNotFound: {}
ServiceQuotaExceededException: {}
DeleteActivityOutput:
type: object
properties: {}
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.
DeleteStateMachineOutput:
type: object
properties: {}
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.
DeleteStateMachineAliasOutput:
type: object
properties: {}
DeleteStateMachineAliasInput:
type: object
required:
- stateMachineAliasArn
title: DeleteStateMachineAliasInput
properties:
stateMachineAliasArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the state machine alias to delete.
DeleteStateMachineVersionOutput:
type: object
properties: {}
DeleteStateMachineVersionInput:
type: object
required:
- stateMachineVersionArn
title: DeleteStateMachineVersionInput
properties:
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/LongArn'
- description: The Amazon Resource Name (ARN) of the state machine version to delete.
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:
white space
brackets < > { } [ ]
wildcard
characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
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. 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. ActivityDoesNotExist: {} 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:
white space
brackets < > { } [ ]
wildcard
characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
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 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.
The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated
by a colon (:). For example, stateMachineARN:1.
If you start an execution from a StartExecution request without specifying a state machine version or alias
ARN, Step Functions returns a null value.
The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by
a colon (:). For example, stateMachineARN:PROD.
If you start an execution from a StartExecution request with a state machine version ARN, this field will be
null.
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.'
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.
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.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version
ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
The name of the state machine.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F,
U+007F-009F)
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: Thetype of the state machine (STANDARD or EXPRESS).
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the state machine is created.
For a state machine version, creationDate is the date the version was created.
Map state. This parameter is present only if the stateMachineArn specified in input is a
qualified state machine ARN.
revisionId:
allOf:
- $ref: '#/components/schemas/RevisionId'
- description: 'The revision identifier for the state machine.
Use the revisionId parameter to compare between versions of a state machine configuration used for executions
without performing a diff of the properties, such as definition and roleArn.
The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that
version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
' DescribeStateMachineAliasInput: type: object required: - stateMachineAliasArn title: DescribeStateMachineAliasInput properties: stateMachineAliasArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine alias. 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 theexecutionArn 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.
revisionId:
allOf:
- $ref: '#/components/schemas/RevisionId'
- description: 'The revision identifier for the state machine. The first revision ID when you create the state machine is null.
Use the state machine revisionId parameter
to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and
roleArn.
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.'
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 theirtimeStamp.
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.
InvalidToken: {}
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.'
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: 'IfnextToken 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.'
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.'
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.
You can also return a list of executions associated with a specific alias
or version, by specifying an alias ARN or a version ARN in the stateMachineArn
parameter.
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: 'IfnextToken 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.
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.'
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: 'IfnextToken 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.'
ListStateMachineAliasesOutput:
type: object
required:
- stateMachineAliases
properties:
stateMachineAliases:
allOf:
- $ref: '#/components/schemas/StateMachineAliasList'
- description: Aliases for the state machine.
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.'
ListStateMachineAliasesInput:
type: object
required:
- stateMachineArn
title: ListStateMachineAliasesInput
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.
If you specify a state machine version ARN, this API returns a list of aliases for that version.
' nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: 'IfnextToken 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.'
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.
ListStateMachineVersionsOutput: type: object required: - stateMachineVersions properties: stateMachineVersions: allOf: - $ref: '#/components/schemas/StateMachineVersionList' - description: Versions for the state machine. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: 'IfnextToken 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.'
ListStateMachineVersionsInput:
type: object
required:
- stateMachineArn
title: ListStateMachineVersionsInput
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the state machine.
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.'
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.
ListStateMachinesOutput: type: object required: - stateMachines properties: stateMachines: $ref: '#/components/schemas/StateMachineList' nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: 'IfnextToken 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.'
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: 'IfnextToken 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.'
ListTagsForResourceOutput:
type: object
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: An array of tags associated with the resource.
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.
PublishStateMachineVersionOutput:
type: object
required:
- creationDate
- stateMachineVersionArn
properties:
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the version was created.
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
PublishStateMachineVersionInput:
type: object
required:
- stateMachineArn
title: PublishStateMachineVersionInput
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the state machine.
revisionId:
allOf:
- $ref: '#/components/schemas/RevisionId'
- description: 'Only publish the state machine version if the current state machine''s revision ID matches the specified ID.
Use this option to avoid publishing a version if the state
machine changed since you last updated it. If the specified revision ID doesn''t match the state machine''s current revision ID, the API returns ConflictException.
To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can
specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.
The Amazon Resource Name (ARN) of the state machine to execute.
The stateMachineArn parameter accepts one of the following inputs:
An unqualified state machine ARN – Refers to a state machine ARN that isn''t qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
Step Functions doesn''t associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.
A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10
Step Functions doesn''t associate executions that you start with a version ARN with any aliases that point to that version.
A state machine alias ARN – Refers
to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.
Optional 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:
white space
brackets
< > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control
characters (U+0000-001F, U+007F-009F)
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. ExecutionLimitExceeded: {} ExecutionAlreadyExists: {} InvalidExecutionInput: {} 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.
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. StopExecutionOutput: type: object required: - stopDate properties: stopDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the execution is stopped. 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. TagResourceOutput: type: object properties: {} 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: _ . : / = + - @.
The Amazon Resource Name (ARN) of the published state machine version.
If the publish parameter isn''t set to true, this field returns null.
LoggingConfiguration data type to set CloudWatch Logs options.
tracingConfiguration:
allOf:
- $ref: '#/components/schemas/TracingConfiguration'
- description: Selects whether X-Ray tracing is enabled.
publish:
allOf:
- $ref: '#/components/schemas/Publish'
- description: 'Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to
true.'
versionDescription:
allOf:
- $ref: '#/components/schemas/VersionDescription'
- description: An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set
publish to true.
The routing configuration of the state machine alias.
An array of RoutingConfig objects that specifies up to two state machine versions that the alias
starts executions for.
The name of the activity.
A name must not contain:
white space
brackets < > { } [ ]
wildcard
characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
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. ActivityList: type: array items: $ref: '#/components/schemas/ActivityListItem' Arn: type: string minLength: 1 maxLength: 256 Name: type: string minLength: 1 maxLength: 80 Timestamp: type: string format: date-time 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. SensitiveData: type: string maxLength: 262144 format: password HistoryEventExecutionDataDetails: type: object properties: truncated: allOf: - $ref: '#/components/schemas/truncated' - description: Indicates whether input or output was truncated in the response. Alwaysfalse for API calls.
description: Provides details about input or output in an execution history event.
TimeoutInSeconds:
type: integer
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.
Identity:
type: string
maxLength: 256
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.
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.
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.
AliasDescription:
type: string
maxLength: 256
format: password
BilledDuration:
type: integer
minimum: 0
BilledMemoryUsed:
type: integer
minimum: 0
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.
CharacterRestrictedName:
type: string
pattern: '^(?=.*[a-zA-Z_\-\.])[a-zA-Z0-9_\-\.]+$'
minLength: 1
maxLength: 80
includedDetails:
type: boolean
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.
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:
ConnectorParameters:
type: string
minLength: 0
maxLength: 262144
format: password
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
RoutingConfigurationList:
type: array
items:
$ref: '#/components/schemas/RoutingConfigurationListItem'
minItems: 1
maxItems: 2
Definition:
type: string
minLength: 1
maxLength: 1048576
format: password
StateMachineType:
type: string
enum:
- STANDARD
- EXPRESS
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.
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 '
Publish:
type: boolean
VersionDescription:
type: string
maxLength: 256
format: password
LongArn:
type: string
minLength: 1
maxLength: 2000
ExecutionStatus:
type: string
enum:
- RUNNING
- SUCCEEDED
- FAILED
- TIMED_OUT
- ABORTED
TraceHeader:
type: string
pattern: '\p{ASCII}*'
minLength: 0
maxLength: 256
MapRunStatus:
type: string
enum:
- RUNNING
- SUCCEEDED
- FAILED
- ABORTED
MaxConcurrency:
type: integer
minimum: 0
ToleratedFailurePercentage:
type: number
format: float
minimum: 0
maximum: 100
ToleratedFailureCount:
type: integer
minimum: 0
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.
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.
MapRunLabel:
type: string
RevisionId:
type: string
StateMachineStatus:
type: string
enum:
- ACTIVE
- DELETING
Enabled:
type: boolean
EventId:
type: integer
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.
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.
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 state machine that ran the execution.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the execution.
A name must not contain:
white space
brackets < > { } [ ]
wildcard
characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
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 ifmapRunArn 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.'
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the state machine version associated with the execution.
If the state machine execution was started with an unqualified ARN, it returns null.
If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the
respective values.
The Amazon Resource Name (ARN) of the state machine alias used to start an execution.
If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.
' description: Contains details about an execution. ExecutionList: type: array items: $ref: '#/components/schemas/ExecutionListItem' UnsignedInteger: type: integer minimum: 0 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. stateMachineAliasArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution. stateMachineVersionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution. description: Contains details about the start of the execution. 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. 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. TaskToken: type: string minLength: 1 maxLength: 1024 SensitiveDataJobInput: type: string maxLength: 262144 format: password PageSize: type: integer minimum: 0 maximum: 1000 ReverseOrder: type: boolean PageToken: type: string minLength: 1 maxLength: 1024 IncludeExecutionDataGetExecutionHistory: type: boolean HistoryEventList: type: array description: Contains details about the events that occurred during an execution. items: $ref: '#/components/schemas/HistoryEvent' 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 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. 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. 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. 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. 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. 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 . 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. StateExitedEventDetails: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/Name' - description: 'The name of the state.
A name must not contain:
white space
brackets < > { } [ ]
wildcard
characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
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. 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. 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. 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 asmapRunArn, 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.
truncated:
type: boolean
IncludeExecutionData:
type: boolean
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.
ListExecutionsPageToken:
type: string
minLength: 1
maxLength: 3096
MapRunList:
type: array
items:
$ref: '#/components/schemas/MapRunListItem'
StateMachineAliasList:
type: array
items:
$ref: '#/components/schemas/StateMachineAliasListItem'
StateMachineVersionList:
type: array
items:
$ref: '#/components/schemas/StateMachineVersionListItem'
StateMachineList:
type: array
items:
$ref: '#/components/schemas/StateMachineListItem'
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:
LogDestinationList:
type: array
items:
$ref: '#/components/schemas/LogDestination'
LogLevel:
type: string
enum:
- ALL
- ERROR
- FATAL
- 'OFF'
UnsignedLong:
type: integer
minimum: 0
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.
RoutingConfigurationListItem:
type: object
required:
- stateMachineVersionArn
- weight
properties:
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
If you specify the ARN of a second version, it must belong to the same state machine as the first version.
' weight: allOf: - $ref: '#/components/schemas/VersionWeight' - description: The percentage of traffic you want to route to the second state machine version. The sum of the weights in the routing configuration must be equal to 100. description: 'Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.' VersionWeight: type: integer minimum: 0 maximum: 100 SyncExecutionStatus: type: string enum: - SUCCEEDED - FAILED - TIMED_OUT StateMachineAliasListItem: type: object required: - stateMachineAliasArn - creationDate properties: stateMachineAliasArn: allOf: - $ref: '#/components/schemas/LongArn' - description: 'The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example,stateMachineARN:PROD.'
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The creation date of a state machine alias.
description: Contains details about a specific state machine alias.
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:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F,
U+007F-009F)
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. StateMachineVersionListItem: type: object required: - stateMachineVersionArn - creationDate properties: stateMachineVersionArn: allOf: - $ref: '#/components/schemas/LongArn' - description: 'The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example,stateMachineARN:1.'
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The creation date of a state machine version.
description: Contains details about a specific state machine version.
TagKey:
type: string
minLength: 1
maxLength: 128
TagValue:
type: string
minLength: 0
maxLength: 256
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: _ . : / = + - @.