Class: AWS.StepFunctions

createActivity(params = {}, callback) ⇒ `AWS.Request`

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.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Note: 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.

Service Reference:

CreateActivity

Examples:

Calling the createActivity operation

var params = {
  name: 'STRING_VALUE', /* required */
  encryptionConfiguration: {
    type: AWS_OWNED_KEY | CUSTOMER_MANAGED_KMS_KEY, /* required */
    kmsDataKeyReusePeriodSeconds: 'NUMBER_VALUE',
    kmsKeyId: 'STRING_VALUE'
  },
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
stepfunctions.createActivity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- name — (String)
  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 — (Array<map>)
  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: _ . : / = + - @.
  - key — (String)
    The key of a tag.
  - value — (String)
    The value of a tag.
- encryptionConfiguration — (map)
  Settings to configure server-side encryption.
  - kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  - kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  - type — required — (String)
    Encryption type
    Possible values include:
    - "AWS_OWNED_KEY"
    - "CUSTOMER_MANAGED_KMS_KEY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - activityArn — (String)
    The Amazon Resource Name (ARN) that identifies the created activity.
  - creationDate — (Date)
    The date the activity is created.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createStateMachine(params = {}, callback) ⇒ `AWS.Request`

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.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Note: 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, TracingConfiguration, and EncryptionConfiguration 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.

Service Reference:

CreateStateMachine

Examples:

Calling the createStateMachine operation

var params = {
  definition: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  encryptionConfiguration: {
    type: AWS_OWNED_KEY | CUSTOMER_MANAGED_KMS_KEY, /* required */
    kmsDataKeyReusePeriodSeconds: 'NUMBER_VALUE',
    kmsKeyId: 'STRING_VALUE'
  },
  loggingConfiguration: {
    destinations: [
      {
        cloudWatchLogsLogGroup: {
          logGroupArn: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    includeExecutionData: true || false,
    level: ALL | ERROR | FATAL | OFF
  },
  publish: true || false,
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  tracingConfiguration: {
    enabled: true || false
  },
  type: STANDARD | EXPRESS,
  versionDescription: 'STRING_VALUE'
};
stepfunctions.createStateMachine(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- name — (String)
  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 — (String)
  The Amazon States Language definition of the state machine. See Amazon States Language.
- roleArn — (String)
  The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
- type — (String)
  Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.
  Possible values include:
  - "STANDARD"
  - "EXPRESS"
- loggingConfiguration — (map)
  Defines what execution history events are logged and where they are logged.
  
  Note: By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.
  - level — (String)
    Defines which category of execution history events are logged.
    Possible values include:
    - "ALL"
    - "ERROR"
    - "FATAL"
    - "OFF"
  - includeExecutionData — (Boolean)
    Determines whether execution data is included in your log. When set to false, data is excluded.
  - destinations — (Array<map>)
    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.
    - cloudWatchLogsLogGroup — (map)
      An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
      
      logGroupArn — (String)
      The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
- tags — (Array<map>)
  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: _ . : / = + - @.
  - key — (String)
    The key of a tag.
  - value — (String)
    The value of a tag.
- tracingConfiguration — (map)
  Selects whether X-Ray tracing is enabled.
  - enabled — (Boolean)
    When set to true, X-Ray tracing is enabled.
- publish — (Boolean)
  Set to true to publish the first version of the state machine during creation. The default is false.
- versionDescription — (String)
  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.
- encryptionConfiguration — (map)
  Settings to configure server-side encryption.
  - kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  - kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  - type — required — (String)
    Encryption type
    Possible values include:
    - "AWS_OWNED_KEY"
    - "CUSTOMER_MANAGED_KMS_KEY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineArn — (String)
    The Amazon Resource Name (ARN) that identifies the created state machine.
  - creationDate — (Date)
    The date the state machine is created.
  - stateMachineVersionArn — (String)
    The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

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:

DescribeStateMachineAlias
ListStateMachineAliases
UpdateStateMachineAlias
DeleteStateMachineAlias

Service Reference:

CreateStateMachineAlias

Examples:

Calling the createStateMachineAlias operation

var params = {
  name: 'STRING_VALUE', /* required */
  routingConfiguration: [ /* required */
    {
      stateMachineVersionArn: 'STRING_VALUE', /* required */
      weight: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  description: 'STRING_VALUE'
};
stepfunctions.createStateMachineAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- description — (String)
  A description for the state machine alias.
- name — (String)
  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 — (Array<map>)
  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.
  - stateMachineVersionArn — required — (String)
    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 — required — (Integer)
    The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineAliasArn — (String)
    The Amazon Resource Name (ARN) that identifies the created state machine alias.
  - creationDate — (Date)
    The date the state machine alias was created.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteActivity(params = {}, callback) ⇒ `AWS.Request`

Deletes an activity.

Service Reference:

DeleteActivity

Examples:

Calling the deleteActivity operation

var params = {
  activityArn: 'STRING_VALUE' /* required */
};
stepfunctions.deleteActivity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- activityArn — (String)
  The Amazon Resource Name (ARN) of the activity to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteStateMachine(params = {}, callback) ⇒ `AWS.Request`

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.

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

Note: 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.

Note: For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

Service Reference:

DeleteStateMachine

Examples:

Calling the deleteStateMachine operation

var params = {
  stateMachineArn: 'STRING_VALUE' /* required */
};
stepfunctions.deleteStateMachine(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  The Amazon Resource Name (ARN) of the state machine to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

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:

CreateStateMachineAlias
DescribeStateMachineAlias
ListStateMachineAliases
UpdateStateMachineAlias

Service Reference:

DeleteStateMachineAlias

Examples:

Calling the deleteStateMachineAlias operation

var params = {
  stateMachineAliasArn: 'STRING_VALUE' /* required */
};
stepfunctions.deleteStateMachineAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineAliasArn — (String)
  The Amazon Resource Name (ARN) of the state machine alias to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteStateMachineVersion(params = {}, callback) ⇒ `AWS.Request`

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.

Note: Deleting a state machine version won't terminate its in-progress executions.

Note: 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:

PublishStateMachineVersion
ListStateMachineVersions

Service Reference:

DeleteStateMachineVersion

Examples:

Calling the deleteStateMachineVersion operation

var params = {
  stateMachineVersionArn: 'STRING_VALUE' /* required */
};
stepfunctions.deleteStateMachineVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineVersionArn — (String)
  The Amazon Resource Name (ARN) of the state machine version to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeActivity(params = {}, callback) ⇒ `AWS.Request`

Describes an activity.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

DescribeActivity

Examples:

Calling the describeActivity operation

var params = {
  activityArn: 'STRING_VALUE' /* required */
};
stepfunctions.describeActivity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- activityArn — (String)
  The Amazon Resource Name (ARN) of the activity to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - activityArn — (String)
    The Amazon Resource Name (ARN) that identifies the activity.
  - name — (String)
    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 — (Date)
    The date the activity is created.
  - encryptionConfiguration — (map)
    Settings for configured server-side encryption.
    
    kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    type — required — (String)
    Encryption type
    Possible values include:
    
    "AWS_OWNED_KEY"
    
    "CUSTOMER_MANAGED_KMS_KEY"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeExecution(params = {}, callback) ⇒ `AWS.Request`

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. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can 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.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

Service Reference:

DescribeExecution

Examples:

Calling the describeExecution operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  includedData: ALL_DATA | METADATA_ONLY
};
stepfunctions.describeExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution to describe.
- includedData — (String)
  If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call DescribeStateMachine API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.
  Possible values include:
  - "ALL_DATA"
  - "METADATA_ONLY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - executionArn — (String)
    The Amazon Resource Name (ARN) that identifies the execution.
  - stateMachineArn — (String)
    The Amazon Resource Name (ARN) of the executed stated machine.
  - name — (String)
    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 — (String)
    The current status of the execution.
    Possible values include:
    
    "RUNNING"
    
    "SUCCEEDED"
    
    "FAILED"
    
    "TIMED_OUT"
    
    "ABORTED"
    
    "PENDING_REDRIVE"
  - startDate — (Date)
    The date the execution is started.
  - stopDate — (Date)
    If the execution ended, the date the execution stopped.
  - input — (String)
    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 — (map)
    Provides details about execution input or output.
    
    included — (Boolean)
    Indicates whether input or output was included in the response. Always true for API calls.
  - output — (String)
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Note: This field is set only if the execution succeeds. If the execution fails, this field is null.
  - outputDetails — (map)
    Provides details about execution input or output.
    
    included — (Boolean)
    Indicates whether input or output was included in the response. Always true for API calls.
  - traceHeader — (String)
    The X-Ray trace header that was passed to the execution.
  - mapRunArn — (String)
    The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
  - error — (String)
    The error string if the state machine execution failed.
  - cause — (String)
    The cause string if the state machine execution failed.
  - stateMachineVersionArn — (String)
    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.
  - stateMachineAliasArn — (String)
    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.
  - redriveCount — (Integer)
    The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.
  - redriveDate — (Date)
    The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.
    
    The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.
  - redriveStatus — (String)
    Indicates whether or not an execution can be redriven at a given point in time.
    
    For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.
    
    For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.
    
    For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.
    
    You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
    
    Possible values include:
    
    "REDRIVABLE"
    
    "NOT_REDRIVABLE"
    
    "REDRIVABLE_BY_MAP_RUN"
  - redriveStatusReason — (String)
    When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.
    
    For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:
    
    State machine is in DELETING status.
    
    Execution is RUNNING and cannot be redriven.
    
    Execution is SUCCEEDED and cannot be redriven.
    
    Execution was started before the launch of RedriveExecution.
    
    Execution history event limit exceeded.
    
    Execution has exceeded the max execution time.
    
    Execution redrivable period exceeded.
    
    For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeMapRun(params = {}, callback) ⇒ `AWS.Request`

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Service Reference:

DescribeMapRun

Examples:

Calling the describeMapRun operation

var params = {
  mapRunArn: 'STRING_VALUE' /* required */
};
stepfunctions.describeMapRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- mapRunArn — (String)
  The Amazon Resource Name (ARN) that identifies a Map Run.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - mapRunArn — (String)
    The Amazon Resource Name (ARN) that identifies a Map Run.
  - executionArn — (String)
    The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
  - status — (String)
    The current status of the Map Run.
    Possible values include:
    
    "RUNNING"
    
    "SUCCEEDED"
    
    "FAILED"
    
    "ABORTED"
  - startDate — (Date)
    The date when the Map Run was started.
  - stopDate — (Date)
    The date when the Map Run was stopped.
  - maxConcurrency — (Integer)
    The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
  - toleratedFailurePercentage — (Float)
    The maximum percentage of failed child workflow executions before the Map Run fails.
  - toleratedFailureCount — (Integer)
    The maximum number of failed child workflow executions before the Map Run fails.
  - itemCounts — (map)
    A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.
    
    pending — required — (Integer)
    The total number of items to process in child workflow executions that haven't started running yet.
    
    running — required — (Integer)
    The total number of items being processed in child workflow executions that are currently in-progress.
    
    succeeded — required — (Integer)
    The total number of items processed in child workflow executions that have completed successfully.
    
    failed — required — (Integer)
    The total number of items processed in child workflow executions that have failed.
    
    timedOut — required — (Integer)
    The total number of items processed in child workflow executions that have timed out.
    
    aborted — required — (Integer)
    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 — required — (Integer)
    The total number of items processed in all the child workflow executions started by a Map Run.
    
    resultsWritten — required — (Integer)
    Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
    
    failuresNotRedrivable — (Integer)
    The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.
    
    pendingRedrive — (Integer)
    The number of unsuccessful items in child workflow executions currently waiting to be redriven.
  - executionCounts — (map)
    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.
    
    pending — required — (Integer)
    The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.
    
    running — required — (Integer)
    The total number of child workflow executions that were started by a Map Run and are currently in-progress.
    
    succeeded — required — (Integer)
    The total number of child workflow executions that were started by a Map Run and have completed successfully.
    
    failed — required — (Integer)
    The total number of child workflow executions that were started by a Map Run, but have failed.
    
    timedOut — required — (Integer)
    The total number of child workflow executions that were started by a Map Run and have timed out.
    
    aborted — required — (Integer)
    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 — required — (Integer)
    The total number of child workflow executions that were started by a Map Run.
    
    resultsWritten — required — (Integer)
    Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
    
    failuresNotRedrivable — (Integer)
    The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.
    
    pendingRedrive — (Integer)
    The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.
  - redriveCount — (Integer)
    The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.
  - redriveDate — (Date)
    The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeStateMachine(params = {}, callback) ⇒ `AWS.Request`

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

Note: 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>

Note: 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.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

DescribeStateMachine

Examples:

Calling the describeStateMachine operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  includedData: ALL_DATA | METADATA_ONLY
};
stepfunctions.describeStateMachine(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  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.
- includedData — (String)
  If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.
  
  Note: When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.
  Possible values include:
  - "ALL_DATA"
  - "METADATA_ONLY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineArn — (String)
    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.
  - name — (String)
    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 — (String)
    The current status of the state machine.
    Possible values include:
    
    "ACTIVE"
    
    "DELETING"
  - definition — (String)
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    If called with includedData = METADATA_ONLY, the returned definition will be {}.
  - roleArn — (String)
    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 — (String)
    The type of the state machine (STANDARD or EXPRESS).
    Possible values include:
    
    "STANDARD"
    
    "EXPRESS"
  - creationDate — (Date)
    The date the state machine is created.
    
    For a state machine version, creationDate is the date the version was created.
  - loggingConfiguration — (map)
    The LoggingConfiguration data type is used to set CloudWatch Logs options.
    
    level — (String)
    Defines which category of execution history events are logged.
    Possible values include:
    
    "ALL"
    
    "ERROR"
    
    "FATAL"
    
    "OFF"
    
    includeExecutionData — (Boolean)
    Determines whether execution data is included in your log. When set to false, data is excluded.
    
    destinations — (Array<map>)
    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.
    
    cloudWatchLogsLogGroup — (map)
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
    
    logGroupArn — (String)
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
  - tracingConfiguration — (map)
    Selects whether X-Ray tracing is enabled.
    
    enabled — (Boolean)
    When set to true, X-Ray tracing is enabled.
  - label — (String)
    A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
  - revisionId — (String)
    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.
  - description — (String)
    The description of the state machine version.
  - encryptionConfiguration — (map)
    Settings to configure server-side encryption.
    
    kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    type — required — (String)
    Encryption type
    Possible values include:
    
    "AWS_OWNED_KEY"
    
    "CUSTOMER_MANAGED_KMS_KEY"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

Returns details about a state machine alias.

Related operations:

CreateStateMachineAlias
ListStateMachineAliases
UpdateStateMachineAlias
DeleteStateMachineAlias

Service Reference:

DescribeStateMachineAlias

Examples:

Calling the describeStateMachineAlias operation

var params = {
  stateMachineAliasArn: 'STRING_VALUE' /* required */
};
stepfunctions.describeStateMachineAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineAliasArn — (String)
  The Amazon Resource Name (ARN) of the state machine alias.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineAliasArn — (String)
    The Amazon Resource Name (ARN) of the state machine alias.
  - name — (String)
    The name of the state machine alias.
  - description — (String)
    A description of the alias.
  - routingConfiguration — (Array<map>)
    The routing configuration of the alias.
    
    stateMachineVersionArn — required — (String)
    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 — required — (Integer)
    The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.
  - creationDate — (Date)
    The date the state machine alias was created.
  - updateDate — (Date)
    The date the state machine alias was last updated.
    
    For a newly created state machine, this is the same as the creation date.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeStateMachineForExecution(params = {}, callback) ⇒ `AWS.Request`

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.

Note: 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.

Service Reference:

DescribeStateMachineForExecution

Examples:

Calling the describeStateMachineForExecution operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  includedData: ALL_DATA | METADATA_ONLY
};
stepfunctions.describeStateMachineForExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution you want state machine information for.
- includedData — (String)
  If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.
  Possible values include:
  - "ALL_DATA"
  - "METADATA_ONLY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineArn — (String)
    The Amazon Resource Name (ARN) of the state machine associated with the execution.
  - name — (String)
    The name of the state machine associated with the execution.
  - definition — (String)
    The Amazon States Language definition of the state machine. See Amazon States Language.
  - roleArn — (String)
    The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
  - updateDate — (Date)
    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 — (map)
    The LoggingConfiguration data type is used to set CloudWatch Logs options.
    
    level — (String)
    Defines which category of execution history events are logged.
    Possible values include:
    
    "ALL"
    
    "ERROR"
    
    "FATAL"
    
    "OFF"
    
    includeExecutionData — (Boolean)
    Determines whether execution data is included in your log. When set to false, data is excluded.
    
    destinations — (Array<map>)
    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.
    
    cloudWatchLogsLogGroup — (map)
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
    
    logGroupArn — (String)
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
  - tracingConfiguration — (map)
    Selects whether X-Ray tracing is enabled.
    
    enabled — (Boolean)
    When set to true, X-Ray tracing is enabled.
  - mapRunArn — (String)
    The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
  - label — (String)
    A user-defined or an auto-generated string that identifies a Map state. This ﬁeld is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
  - revisionId — (String)
    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.
  - encryptionConfiguration — (map)
    Settings to configure server-side encryption.
    
    kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
    
    type — required — (String)
    Encryption type
    Possible values include:
    
    "AWS_OWNED_KEY"
    
    "CUSTOMER_MANAGED_KMS_KEY"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getActivityTask(params = {}, callback) ⇒ `AWS.Request`

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.

Note: 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.

Service Reference:

GetActivityTask

Examples:

Calling the getActivityTask operation

var params = {
  activityArn: 'STRING_VALUE', /* required */
  workerName: 'STRING_VALUE'
};
stepfunctions.getActivityTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- activityArn — (String)
  The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
- workerName — (String)
  You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - taskToken — (String)
    A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
  - input — (String)
    The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getExecutionHistory(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

GetExecutionHistory

Examples:

Calling the getExecutionHistory operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  includeExecutionData: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  reverseOrder: true || false
};
stepfunctions.getExecutionHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution.
- maxResults — (Integer)
  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 — (Boolean)
  Lists events in descending order of their timeStamp.
- nextToken — (String)
  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 — (Boolean)
  You can select whether execution data (input or output of a history event) is returned. The default is true.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - events — (Array<map>)
    The list of events that occurred in the execution.
    
    timestamp — required — (Date)
    The date and time the event occurred.
    
    type — required — (String)
    The type of the event.
    Possible values include:
    
    "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"
    
    "ExecutionRedriven"
    
    "MapRunRedriven"
    
    id — required — (Integer)
    The id of the event. Events are numbered sequentially, starting at one.
    
    previousEventId — (Integer)
    The id of the previous event.
    
    activityFailedEventDetails — (map)
    Contains details about an activity that failed during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    activityScheduleFailedEventDetails — (map)
    Contains details about an activity schedule event that failed during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    activityScheduledEventDetails — (map)
    Contains details about an activity scheduled during an execution.
    
    resource — required — (String)
    The Amazon Resource Name (ARN) of the scheduled activity.
    
    input — (String)
    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 — (map)
    Contains details about the input for an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    timeoutInSeconds — (Integer)
    The maximum allowed duration of the activity task.
    
    heartbeatInSeconds — (Integer)
    The maximum allowed duration between two heartbeats for the activity task.
    
    activityStartedEventDetails — (map)
    Contains details about the start of an activity during an execution.
    
    workerName — (String)
    The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
    
    activitySucceededEventDetails — (map)
    Contains details about an activity that successfully terminated during an execution.
    
    output — (String)
    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 — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    activityTimedOutEventDetails — (map)
    Contains details about an activity timeout that occurred during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the timeout.
    
    taskFailedEventDetails — (map)
    Contains details about the failure of a task.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    taskScheduledEventDetails — (map)
    Contains details about a task that was scheduled.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    region — required — (String)
    The region of the scheduled task
    
    parameters — required — (String)
    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 — (Integer)
    The maximum allowed duration of the task.
    
    heartbeatInSeconds — (Integer)
    The maximum allowed duration between two heartbeats for the task.
    
    taskCredentials — (map)
    The credentials that Step Functions uses for the task.
    
    roleArn — (String)
    The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
    
    taskStartFailedEventDetails — (map)
    Contains details about a task that failed to start.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    taskStartedEventDetails — (map)
    Contains details about a task that was started.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    taskSubmitFailedEventDetails — (map)
    Contains details about a task that where the submit failed.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    taskSubmittedEventDetails — (map)
    Contains details about a submitted task.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    output — (String)
    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 — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    taskSucceededEventDetails — (map)
    Contains details about a task that succeeded.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    output — (String)
    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 — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    taskTimedOutEventDetails — (map)
    Contains details about a task that timed out.
    
    resourceType — required — (String)
    The service name of the resource in a task state.
    
    resource — required — (String)
    The action of the resource called by a task state.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    executionFailedEventDetails — (map)
    Contains details about an execution failure event.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    executionStartedEventDetails — (map)
    Contains details about the start of the execution.
    
    input — (String)
    The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    inputDetails — (map)
    Contains details about the input for an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    roleArn — (String)
    The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
    
    stateMachineAliasArn — (String)
    The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
    
    stateMachineVersionArn — (String)
    The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
    
    executionSucceededEventDetails — (map)
    Contains details about the successful termination of the execution.
    
    output — (String)
    The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    outputDetails — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    executionAbortedEventDetails — (map)
    Contains details about an abort of an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    executionTimedOutEventDetails — (map)
    Contains details about the execution timeout that occurred during the execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the timeout.
    
    executionRedrivenEventDetails — (map)
    Contains details about the redrive attempt of an execution.
    
    redriveCount — (Integer)
    The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.
    
    mapStateStartedEventDetails — (map)
    Contains details about Map state that was started.
    
    length — (Integer)
    The size of the array for Map state iterations.
    
    mapIterationStartedEventDetails — (map)
    Contains details about an iteration of a Map state that was started.
    
    name — (String)
    The name of the iteration’s parent Map state.
    
    index — (Integer)
    The index of the array belonging to the Map state iteration.
    
    mapIterationSucceededEventDetails — (map)
    Contains details about an iteration of a Map state that succeeded.
    
    name — (String)
    The name of the iteration’s parent Map state.
    
    index — (Integer)
    The index of the array belonging to the Map state iteration.
    
    mapIterationFailedEventDetails — (map)
    Contains details about an iteration of a Map state that failed.
    
    name — (String)
    The name of the iteration’s parent Map state.
    
    index — (Integer)
    The index of the array belonging to the Map state iteration.
    
    mapIterationAbortedEventDetails — (map)
    Contains details about an iteration of a Map state that was aborted.
    
    name — (String)
    The name of the iteration’s parent Map state.
    
    index — (Integer)
    The index of the array belonging to the Map state iteration.
    
    lambdaFunctionFailedEventDetails — (map)
    Contains details about a Lambda function that failed during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    lambdaFunctionScheduleFailedEventDetails — (map)
    Contains details about a failed Lambda function schedule event that occurred during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    lambdaFunctionScheduledEventDetails — (map)
    Contains details about a Lambda function scheduled during an execution.
    
    resource — required — (String)
    The Amazon Resource Name (ARN) of the scheduled Lambda function.
    
    input — (String)
    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 — (map)
    Contains details about input for an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    timeoutInSeconds — (Integer)
    The maximum allowed duration of the Lambda function.
    
    taskCredentials — (map)
    The credentials that Step Functions uses for the task.
    
    roleArn — (String)
    The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
    
    lambdaFunctionStartFailedEventDetails — (map)
    Contains details about a lambda function that failed to start during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    lambdaFunctionSucceededEventDetails — (map)
    Contains details about a Lambda function that terminated successfully during an execution.
    
    output — (String)
    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 — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    lambdaFunctionTimedOutEventDetails — (map)
    Contains details about a Lambda function timeout that occurred during an execution.
    
    error — (String)
    The error code of the failure.
    
    cause — (String)
    A more detailed explanation of the cause of the timeout.
    
    stateEnteredEventDetails — (map)
    Contains details about a state entered during an execution.
    
    name — required — (String)
    The name of the state.
    
    input — (String)
    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 — (map)
    Contains details about the input for an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    stateExitedEventDetails — (map)
    Contains details about an exit from a state during an execution.
    
    name — required — (String)
    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 — (String)
    The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    outputDetails — (map)
    Contains details about the output of an execution history event.
    
    truncated — (Boolean)
    Indicates whether input or output was truncated in the response. Always false for API calls.
    
    mapRunStartedEventDetails — (map)
    Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.
    
    mapRunArn — (String)
    The Amazon Resource Name (ARN) of a Map Run that was started.
    
    mapRunFailedEventDetails — (map)
    Contains error and cause details about a Map Run that failed.
    
    error — (String)
    The error code of the Map Run failure.
    
    cause — (String)
    A more detailed explanation of the cause of the failure.
    
    mapRunRedrivenEventDetails — (map)
    Contains details about the redrive attempt of a Map Run.
    
    mapRunArn — (String)
    The Amazon Resource Name (ARN) of a Map Run that was redriven.
    
    redriveCount — (Integer)
    The number of times the Map Run has been redriven at this point in the execution's history including this event. The redrive count for a redriven Map Run is always greater than 0.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listActivities(params = {}, callback) ⇒ `AWS.Request`

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.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

ListActivities

Examples:

Calling the listActivities operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
stepfunctions.listActivities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- maxResults — (Integer)
  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 — (String)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - activities — (Array<map>)
    The list of activities.
    
    activityArn — required — (String)
    The Amazon Resource Name (ARN) that identifies the activity.
    
    name — required — (String)
    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 — required — (Date)
    The date the activity is created.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listExecutions(params = {}, callback) ⇒ `AWS.Request`

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. Using this API action, you can also list all redriven executions.

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.

Note: 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.

Service Reference:

ListExecutions

Examples:

Calling the listExecutions operation

var params = {
  mapRunArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  redriveFilter: REDRIVEN | NOT_REDRIVEN,
  stateMachineArn: 'STRING_VALUE',
  statusFilter: RUNNING | SUCCEEDED | FAILED | TIMED_OUT | ABORTED | PENDING_REDRIVE
};
stepfunctions.listExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  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.
- statusFilter — (String)
  If specified, only list the executions whose current execution status matches the given filter.
  Possible values include:
  - "RUNNING"
  - "SUCCEEDED"
  - "FAILED"
  - "TIMED_OUT"
  - "ABORTED"
  - "PENDING_REDRIVE"
- maxResults — (Integer)
  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 — (String)
  If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- mapRunArn — (String)
  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.
- redriveFilter — (String)
  Sets a filter to list executions based on whether or not they have been redriven.
  
  For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
  
  If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
  
  If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
  Possible values include:
  - "REDRIVEN"
  - "NOT_REDRIVEN"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - executions — (Array<map>)
    The list of matching executions.
    
    executionArn — required — (String)
    The Amazon Resource Name (ARN) that identifies the execution.
    
    stateMachineArn — required — (String)
    The Amazon Resource Name (ARN) of the state machine that ran the execution.
    
    name — required — (String)
    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 — required — (String)
    The current status of the execution.
    Possible values include:
    
    "RUNNING"
    
    "SUCCEEDED"
    
    "FAILED"
    
    "TIMED_OUT"
    
    "ABORTED"
    
    "PENDING_REDRIVE"
    
    startDate — required — (Date)
    The date the execution started.
    
    stopDate — (Date)
    If the execution already ended, the date the execution stopped.
    
    mapRunArn — (String)
    The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.
    
    itemCount — (Integer)
    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 — (String)
    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.
    
    stateMachineAliasArn — (String)
    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.
    
    redriveCount — (Integer)
    The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.
    
    redriveDate — (Date)
    The date the execution was last redriven.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listMapRuns(params = {}, callback) ⇒ `AWS.Request`

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

Service Reference:

ListMapRuns

Examples:

Calling the listMapRuns operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
stepfunctions.listMapRuns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
- maxResults — (Integer)
  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 — (String)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - mapRuns — (Array<map>)
    An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.
    
    executionArn — required — (String)
    The executionArn of the execution from which the Map Run was started.
    
    mapRunArn — required — (String)
    The Amazon Resource Name (ARN) of the Map Run.
    
    stateMachineArn — required — (String)
    The Amazon Resource Name (ARN) of the executed state machine.
    
    startDate — required — (Date)
    The date on which the Map Run started.
    
    stopDate — (Date)
    The date on which the Map Run stopped.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listStateMachineAliases(params = {}, callback) ⇒ `AWS.Request`

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:

CreateStateMachineAlias
DescribeStateMachineAlias
UpdateStateMachineAlias
DeleteStateMachineAlias

Service Reference:

ListStateMachineAliases

Examples:

Calling the listStateMachineAliases operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
stepfunctions.listStateMachineAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  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 — (String)
  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 — (Integer)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineAliases — (Array<map>)
    Aliases for the state machine.
    
    stateMachineAliasArn — required — (String)
    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 — required — (Date)
    The creation date of a state machine alias.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listStateMachines(params = {}, callback) ⇒ `AWS.Request`

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.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

ListStateMachines

Examples:

Calling the listStateMachines operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
stepfunctions.listStateMachines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- maxResults — (Integer)
  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 — (String)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachines — (Array<map>)
    
    stateMachineArn — required — (String)
    The Amazon Resource Name (ARN) that identifies the state machine.
    
    name — required — (String)
    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 — required — (String)
    Possible values include:
    
    "STANDARD"
    
    "EXPRESS"
    
    creationDate — required — (Date)
    The date the state machine is created.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listStateMachineVersions(params = {}, callback) ⇒ `AWS.Request`

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:

PublishStateMachineVersion
DeleteStateMachineVersion

Service Reference:

ListStateMachineVersions

Examples:

Calling the listStateMachineVersions operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
stepfunctions.listStateMachineVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  The Amazon Resource Name (ARN) of the state machine.
- nextToken — (String)
  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 — (Integer)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stateMachineVersions — (Array<map>)
    Versions for the state machine.
    
    stateMachineVersionArn — required — (String)
    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 — required — (Date)
    The creation date of a state machine version.
  - nextToken — (String)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

List tags for a given resource.

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

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
stepfunctions.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - tags — (Array<map>)
    An array of tags associated with the resource.
    
    key — (String)
    The key of a tag.
    
    value — (String)
    The value of a tag.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

publishStateMachineVersion(params = {}, callback) ⇒ `AWS.Request`

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:

DeleteStateMachineVersion
ListStateMachineVersions

Service Reference:

PublishStateMachineVersion

Examples:

Calling the publishStateMachineVersion operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  revisionId: 'STRING_VALUE'
};
stepfunctions.publishStateMachineVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  The Amazon Resource Name (ARN) of the state machine.
- revisionId — (String)
  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.
  
  Note: 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.
- description — (String)
  An optional description of the state machine version.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - creationDate — (Date)
    The date the version was created.
  - stateMachineVersionArn — (String)
    The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

redriveExecution(params = {}, callback) ⇒ `AWS.Request`

Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

Note: This API action is not supported by EXPRESS state machines. However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

You can redrive executions if your original execution meets the following conditions:

The execution status isn't SUCCEEDED.
Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.
The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.
The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

Service Reference:

RedriveExecution

Examples:

Calling the redriveExecution operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
stepfunctions.redriveExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution to be redriven.
- clientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.
  If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - redriveDate — (Date)
    The date the execution was last redriven.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

sendTaskFailure(params = {}, callback) ⇒ `AWS.Request`

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Service Reference:

SendTaskFailure

Examples:

Calling the sendTaskFailure operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  cause: 'STRING_VALUE',
  error: 'STRING_VALUE'
};
stepfunctions.sendTaskFailure(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- taskToken — (String)
  The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
- error — (String)
  The error code of the failure.
- cause — (String)
  A more detailed explanation of the cause of the failure.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

sendTaskHeartbeat(params = {}, callback) ⇒ `AWS.Request`

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run 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 tasks using the job run or callback pattern.

Note: 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.

Service Reference:

SendTaskHeartbeat

Examples:

Calling the sendTaskHeartbeat operation

var params = {
  taskToken: 'STRING_VALUE' /* required */
};
stepfunctions.sendTaskHeartbeat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- taskToken — (String)
  The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

sendTaskSuccess(params = {}, callback) ⇒ `AWS.Request`

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

Service Reference:

SendTaskSuccess

Examples:

Calling the sendTaskSuccess operation

var params = {
  output: 'STRING_VALUE', /* required */
  taskToken: 'STRING_VALUE' /* required */
};
stepfunctions.sendTaskSuccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- taskToken — (String)
  The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
- output — (String)
  The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

startExecution(params = {}, callback) ⇒ `AWS.Request`

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

Note: 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>

Note: 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.

Note: 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.

Service Reference:

StartExecution

Examples:

Calling the startExecution operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  input: 'STRING_VALUE',
  name: 'STRING_VALUE',
  traceHeader: 'STRING_VALUE'
};
stepfunctions.startExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  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.
- name — (String)
  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.
  
  If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.
  
  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 — (String)
  The string that contains the JSON input data for the execution, for example:
  
  "input": "{\"first_name\" : \"test\"}"
  
  Note: 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 — (String)
  Passes the X-Ray trace header. The trace header can also be passed in the request payload.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - executionArn — (String)
    The Amazon Resource Name (ARN) that identifies the execution.
  - startDate — (Date)
    The date the execution is started.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

startSyncExecution(params = {}, callback) ⇒ `AWS.Request`

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

Note: 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.

Note: This API action isn't logged in CloudTrail.

Service Reference:

StartSyncExecution

Examples:

Calling the startSyncExecution operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  includedData: ALL_DATA | METADATA_ONLY,
  input: 'STRING_VALUE',
  name: 'STRING_VALUE',
  traceHeader: 'STRING_VALUE'
};
stepfunctions.startSyncExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  The Amazon Resource Name (ARN) of the state machine to execute.
- name — (String)
  The name of the execution.
- input — (String)
  The string that contains the JSON input data for the execution, for example:
  
  "input": "{\"first_name\" : \"test\"}"
  
  Note: 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 — (String)
  Passes the X-Ray trace header. The trace header can also be passed in the request payload.
- includedData — (String)
  If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.
  Possible values include:
  - "ALL_DATA"
  - "METADATA_ONLY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - executionArn — (String)
    The Amazon Resource Name (ARN) that identifies the execution.
  - stateMachineArn — (String)
    The Amazon Resource Name (ARN) that identifies the state machine.
  - name — (String)
    The name of the execution.
  - startDate — (Date)
    The date the execution is started.
  - stopDate — (Date)
    If the execution has already ended, the date the execution stopped.
  - status — (String)
    The current status of the execution.
    Possible values include:
    
    "SUCCEEDED"
    
    "FAILED"
    
    "TIMED_OUT"
  - error — (String)
    The error code of the failure.
  - cause — (String)
    A more detailed explanation of the cause of the failure.
  - input — (String)
    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 — (map)
    Provides details about execution input or output.
    
    included — (Boolean)
    Indicates whether input or output was included in the response. Always true for API calls.
  - output — (String)
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Note: This field is set only if the execution succeeds. If the execution fails, this field is null.
  - outputDetails — (map)
    Provides details about execution input or output.
    
    included — (Boolean)
    Indicates whether input or output was included in the response. Always true for API calls.
  - traceHeader — (String)
    The X-Ray trace header that was passed to the execution.
  - billingDetails — (map)
    An object that describes workflow billing details, including billed duration and memory use.
    
    billedMemoryUsedInMB — (Integer)
    Billed memory consumption of your workflow, in MB.
    
    billedDurationInMilliseconds — (Integer)
    Billed duration of your workflow, in milliseconds.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

stopExecution(params = {}, callback) ⇒ `AWS.Request`

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Service Reference:

StopExecution

Examples:

Calling the stopExecution operation

var params = {
  executionArn: 'STRING_VALUE', /* required */
  cause: 'STRING_VALUE',
  error: 'STRING_VALUE'
};
stepfunctions.stopExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- executionArn — (String)
  The Amazon Resource Name (ARN) of the execution to stop.
- error — (String)
  The error code of the failure.
- cause — (String)
  A more detailed explanation of the cause of the failure.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - stopDate — (Date)
    The date the execution is stopped.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ `AWS.Request`

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: _ . : / = + - @.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
stepfunctions.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
- tags — (Array<map>)
  The list of tags to add to a resource.
  
  Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
  - key — (String)
    The key of a tag.
  - value — (String)
    The value of a tag.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

testState(params = {}, callback) ⇒ `AWS.Request`

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

A state's input and output processing data flow
An Amazon Web Services service integration request and response
An HTTP Task request and response

You can call this API on only one state at a time. The states that you can test include the following:

The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.

TestState doesn't support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Service Reference:

TestState

Examples:

Calling the testState operation

var params = {
  definition: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  input: 'STRING_VALUE',
  inspectionLevel: INFO | DEBUG | TRACE,
  revealSecrets: true || false
};
stepfunctions.testState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- definition — (String)
  The Amazon States Language (ASL) definition of the state.
- roleArn — (String)
  The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
- input — (String)
  A string that contains the JSON input data for the state.
- inspectionLevel — (String)
  Determines the values to return when a state is tested. You can specify one of the following types:
  - INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.
  - DEBUG: Shows the final state output along with the input and output data processing result.
  - TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
  Each of these levels also provide information about the status of the state execution and the next state to transition to.
  Possible values include:
  - "INFO"
  - "DEBUG"
  - "TRACE"
- revealSecrets — (Boolean)
  Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
  
  If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
  
  By default, revealSecrets is set to false.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - output — (String)
    The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
  - error — (String)
    The error returned when the execution of a state fails.
  - cause — (String)
    A detailed explanation of the cause for the error when the execution of a state fails.
  - inspectionData — (map)
    Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.
    
    input — (String)
    The raw state input.
    
    afterInputPath — (String)
    The input after Step Functions applies the InputPath filter.
    
    afterParameters — (String)
    The effective input after Step Functions applies the Parameters filter.
    
    result — (String)
    The state's raw result.
    
    afterResultSelector — (String)
    The effective result after Step Functions applies the ResultSelector filter.
    
    afterResultPath — (String)
    The effective result combined with the raw state input after Step Functions applies the ResultPath filter.
    
    request — (map)
    The raw HTTP request that is sent when you test an HTTP Task.
    
    protocol — (String)
    The protocol used to make the HTTP request.
    
    method — (String)
    The HTTP method used for the HTTP request.
    
    url — (String)
    The API endpoint used for the HTTP request.
    
    headers — (String)
    The request headers associated with the HTTP request.
    
    body — (String)
    The request body for the HTTP request.
    
    response — (map)
    The raw HTTP response that is returned when you test an HTTP Task.
    
    protocol — (String)
    The protocol used to return the HTTP response.
    
    statusCode — (String)
    The HTTP response status code for the HTTP response.
    
    statusMessage — (String)
    The message associated with the HTTP status code.
    
    headers — (String)
    The response headers associated with the HTTP response.
    
    body — (String)
    The HTTP response returned.
  - nextState — (String)
    The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this ﬁeld doesn't contain a value.
  - status — (String)
    The execution status of the state.
    Possible values include:
    
    "SUCCEEDED"
    
    "FAILED"
    
    "RETRIABLE"
    
    "CAUGHT_ERROR"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ `AWS.Request`

Remove a tag from a Step Functions resource

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
stepfunctions.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
- tagKeys — (Array<String>)
  The list of tags to remove from the resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateMapRun(params = {}, callback) ⇒ `AWS.Request`

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

Service Reference:

UpdateMapRun

Examples:

Calling the updateMapRun operation

var params = {
  mapRunArn: 'STRING_VALUE', /* required */
  maxConcurrency: 'NUMBER_VALUE',
  toleratedFailureCount: 'NUMBER_VALUE',
  toleratedFailurePercentage: 'NUMBER_VALUE'
};
stepfunctions.updateMapRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- mapRunArn — (String)
  The Amazon Resource Name (ARN) of a Map Run.
- maxConcurrency — (Integer)
  The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
- toleratedFailurePercentage — (Float)
  The maximum percentage of failed items before the Map Run fails.
- toleratedFailureCount — (Integer)
  The maximum number of failed items before the Map Run fails.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateStateMachine(params = {}, callback) ⇒ `AWS.Request`

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. 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

Note: 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>

Note: 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.

Note: Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

Note: 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.

Service Reference:

UpdateStateMachine

Examples:

Calling the updateStateMachine operation

var params = {
  stateMachineArn: 'STRING_VALUE', /* required */
  definition: 'STRING_VALUE',
  encryptionConfiguration: {
    type: AWS_OWNED_KEY | CUSTOMER_MANAGED_KMS_KEY, /* required */
    kmsDataKeyReusePeriodSeconds: 'NUMBER_VALUE',
    kmsKeyId: 'STRING_VALUE'
  },
  loggingConfiguration: {
    destinations: [
      {
        cloudWatchLogsLogGroup: {
          logGroupArn: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    includeExecutionData: true || false,
    level: ALL | ERROR | FATAL | OFF
  },
  publish: true || false,
  roleArn: 'STRING_VALUE',
  tracingConfiguration: {
    enabled: true || false
  },
  versionDescription: 'STRING_VALUE'
};
stepfunctions.updateStateMachine(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineArn — (String)
  The Amazon Resource Name (ARN) of the state machine.
- definition — (String)
  The Amazon States Language definition of the state machine. See Amazon States Language.
- roleArn — (String)
  The Amazon Resource Name (ARN) of the IAM role of the state machine.
- loggingConfiguration — (map)
  Use the LoggingConfiguration data type to set CloudWatch Logs options.
  - level — (String)
    Defines which category of execution history events are logged.
    Possible values include:
    - "ALL"
    - "ERROR"
    - "FATAL"
    - "OFF"
  - includeExecutionData — (Boolean)
    Determines whether execution data is included in your log. When set to false, data is excluded.
  - destinations — (Array<map>)
    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.
    - cloudWatchLogsLogGroup — (map)
      An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
      
      logGroupArn — (String)
      The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
- tracingConfiguration — (map)
  Selects whether X-Ray tracing is enabled.
  - enabled — (Boolean)
    When set to true, X-Ray tracing is enabled.
- publish — (Boolean)
  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 — (String)
  An optional description of the state machine version to publish.
  
  You can only specify the versionDescription parameter if you've set publish to true.
- encryptionConfiguration — (map)
  Settings to configure server-side encryption.
  - kmsKeyId — (String)
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  - kmsDataKeyReusePeriodSeconds — (Integer)
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  - type — required — (String)
    Encryption type
    Possible values include:
    - "AWS_OWNED_KEY"
    - "CUSTOMER_MANAGED_KMS_KEY"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - updateDate — (Date)
    The date and time the state machine was updated.
  - revisionId — (String)
    The revision identifier for the updated state machine.
  - stateMachineVersionArn — (String)
    The Amazon Resource Name (ARN) of the published state machine version.
    
    If the publish parameter isn't set to true, this field returns null.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

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.

Note: 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.

Note: 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:

CreateStateMachineAlias
DescribeStateMachineAlias
ListStateMachineAliases
DeleteStateMachineAlias

Service Reference:

UpdateStateMachineAlias

Examples:

Calling the updateStateMachineAlias operation

var params = {
  stateMachineAliasArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  routingConfiguration: [
    {
      stateMachineVersionArn: 'STRING_VALUE', /* required */
      weight: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
stepfunctions.updateStateMachineAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- stateMachineAliasArn — (String)
  The Amazon Resource Name (ARN) of the state machine alias.
- description — (String)
  A description of the state machine alias.
- routingConfiguration — (Array<map>)
  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.
  - stateMachineVersionArn — required — (String)
    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 — required — (Integer)
    The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - updateDate — (Date)
    The date and time the state machine alias was updated.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

validateStateMachineDefinition(params = {}, callback) ⇒ `AWS.Request`

Validates the syntax of a state machine definition.

You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke CreateStateMachine and UpdateStateMachine. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).

Suggested uses for ValidateStateMachineDefinition:

Integrate automated checks into your code review or Continuous Integration (CI) process to validate state machine definitions before starting deployments.
Run the validation from a Git pre-commit hook to check your state machine definitions before committing them to your source repository.

Note: Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.

Service Reference:

ValidateStateMachineDefinition

Examples:

Calling the validateStateMachineDefinition operation

var params = {
  definition: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  severity: ERROR | WARNING,
  type: STANDARD | EXPRESS
};
stepfunctions.validateStateMachineDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- definition — (String)
  The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).
- type — (String)
  The target type of state machine for this definition. The default is STANDARD.
  Possible values include:
  - "STANDARD"
  - "EXPRESS"
- severity — (String)
  Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.
  Possible values include:
  - "ERROR"
  - "WARNING"
- maxResults — (Integer)
  The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.
  
  If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - result — (String)
    The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.
    Possible values include:
    
    "OK"
    
    "FAIL"
  - diagnostics — (Array<map>)
    If the result is OK, this field will be empty. When there are errors, this field will contain an array of Diagnostic objects to help you troubleshoot.
    
    severity — required — (String)
    A value of ERROR means that you cannot create or update a state machine with this definition.
    Possible values include:
    
    "ERROR"
    
    "WARNING"
    
    code — required — (String)
    Identifying code for the diagnostic.
    
    message — required — (String)
    Message describing the diagnostic condition.
    
    location — (String)
    Location of the issue in the state machine, if available.
    
    For errors specific to a field, the location could be in the format: /States/<StateName>/<FieldName>, for example: /States/FailState/ErrorPath.
  - truncated — (Boolean)
    The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Overview

Service Description

Sending a Request Using StepFunctions

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.StepFunctions(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createActivity(params = {}, callback) ⇒ AWS.Request

createStateMachine(params = {}, callback) ⇒ AWS.Request

createStateMachineAlias(params = {}, callback) ⇒ AWS.Request

deleteActivity(params = {}, callback) ⇒ AWS.Request

deleteStateMachine(params = {}, callback) ⇒ AWS.Request

deleteStateMachineAlias(params = {}, callback) ⇒ AWS.Request

deleteStateMachineVersion(params = {}, callback) ⇒ AWS.Request

describeActivity(params = {}, callback) ⇒ AWS.Request

describeExecution(params = {}, callback) ⇒ AWS.Request

describeMapRun(params = {}, callback) ⇒ AWS.Request

describeStateMachine(params = {}, callback) ⇒ AWS.Request

describeStateMachineAlias(params = {}, callback) ⇒ AWS.Request

describeStateMachineForExecution(params = {}, callback) ⇒ AWS.Request

getActivityTask(params = {}, callback) ⇒ AWS.Request

getExecutionHistory(params = {}, callback) ⇒ AWS.Request

listActivities(params = {}, callback) ⇒ AWS.Request

listExecutions(params = {}, callback) ⇒ AWS.Request

listMapRuns(params = {}, callback) ⇒ AWS.Request

listStateMachineAliases(params = {}, callback) ⇒ AWS.Request

listStateMachines(params = {}, callback) ⇒ AWS.Request

listStateMachineVersions(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

publishStateMachineVersion(params = {}, callback) ⇒ AWS.Request

redriveExecution(params = {}, callback) ⇒ AWS.Request

sendTaskFailure(params = {}, callback) ⇒ AWS.Request

sendTaskHeartbeat(params = {}, callback) ⇒ AWS.Request

sendTaskSuccess(params = {}, callback) ⇒ AWS.Request

startExecution(params = {}, callback) ⇒ AWS.Request

startSyncExecution(params = {}, callback) ⇒ AWS.Request

stopExecution(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

testState(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

updateMapRun(params = {}, callback) ⇒ AWS.Request

updateStateMachine(params = {}, callback) ⇒ AWS.Request

updateStateMachineAlias(params = {}, callback) ⇒ AWS.Request

validateStateMachineDefinition(params = {}, callback) ⇒ AWS.Request

new AWS.StepFunctions(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createActivity(params = {}, callback) ⇒ `AWS.Request`

createStateMachine(params = {}, callback) ⇒ `AWS.Request`

createStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

deleteActivity(params = {}, callback) ⇒ `AWS.Request`

deleteStateMachine(params = {}, callback) ⇒ `AWS.Request`

deleteStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

deleteStateMachineVersion(params = {}, callback) ⇒ `AWS.Request`

describeActivity(params = {}, callback) ⇒ `AWS.Request`

describeExecution(params = {}, callback) ⇒ `AWS.Request`

describeMapRun(params = {}, callback) ⇒ `AWS.Request`

describeStateMachine(params = {}, callback) ⇒ `AWS.Request`

describeStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

describeStateMachineForExecution(params = {}, callback) ⇒ `AWS.Request`

getActivityTask(params = {}, callback) ⇒ `AWS.Request`

getExecutionHistory(params = {}, callback) ⇒ `AWS.Request`

listActivities(params = {}, callback) ⇒ `AWS.Request`

listExecutions(params = {}, callback) ⇒ `AWS.Request`

listMapRuns(params = {}, callback) ⇒ `AWS.Request`

listStateMachineAliases(params = {}, callback) ⇒ `AWS.Request`

listStateMachines(params = {}, callback) ⇒ `AWS.Request`

listStateMachineVersions(params = {}, callback) ⇒ `AWS.Request`

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

publishStateMachineVersion(params = {}, callback) ⇒ `AWS.Request`

redriveExecution(params = {}, callback) ⇒ `AWS.Request`

sendTaskFailure(params = {}, callback) ⇒ `AWS.Request`

sendTaskHeartbeat(params = {}, callback) ⇒ `AWS.Request`

sendTaskSuccess(params = {}, callback) ⇒ `AWS.Request`

startExecution(params = {}, callback) ⇒ `AWS.Request`

startSyncExecution(params = {}, callback) ⇒ `AWS.Request`

stopExecution(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

testState(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`

updateMapRun(params = {}, callback) ⇒ `AWS.Request`

updateStateMachine(params = {}, callback) ⇒ `AWS.Request`

updateStateMachineAlias(params = {}, callback) ⇒ `AWS.Request`

validateStateMachineDefinition(params = {}, callback) ⇒ `AWS.Request`