You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.SWF

Inherits:
AWS.Service show all
Identifier:
swf
API Version:
2012-01-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

Sending a Request Using SWF

var swf = new AWS.SWF();
swf.countClosedWorkflowExecutions(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SWF object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var swf = new AWS.SWF({apiVersion: '2012-01-25'});

You can also set the API version globally in AWS.config.apiVersions using the swf service identifier:

AWS.config.apiVersions = {
  swf: '2012-01-25',
  // other service API versions
};

var swf = new AWS.SWF();

Version:

  • 2012-01-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SWF object

var swf = new AWS.SWF({apiVersion: '2012-01-25'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.SWF.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.SWF.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.SWF.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the countClosedWorkflowExecutions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  closeStatusFilter: {
    status: COMPLETED | FAILED | CANCELED | TERMINATED | CONTINUED_AS_NEW | TIMED_OUT /* required */
  },
  closeTimeFilter: {
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  executionFilter: {
    workflowId: 'STRING_VALUE' /* required */
  },
  startTimeFilter: {
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  tagFilter: {
    tag: 'STRING_VALUE' /* required */
  },
  typeFilter: {
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE'
  }
};
swf.countClosedWorkflowExecutions(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow executions to count.

    • startTimeFilter — (map)

      If specified, only workflow executions that meet the start time criteria of the filter are counted.

      Note: startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • closeTimeFilter — (map)

      If specified, only workflow executions that meet the close time criteria of the filter are counted.

      Note: startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • executionFilter — (map)

      If specified, only workflow executions matching the WorkflowId in the filter are counted.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • workflowId — required — (String)

        The workflowId to pass of match the criteria of this filter.

    • typeFilter — (map)

      If specified, indicates the type of the workflow executions to be counted.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • name — required — (String)

        Name of the workflow type.

      • version — (String)

        Version of the workflow type.

    • tagFilter — (map)

      If specified, only executions that have a tag that matches the filter are counted.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • tag — required — (String)

        Specifies the tag that must be associated with the execution for it to meet the filter criteria.

        Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    • closeStatusFilter — (map)

      If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • status — required — (String)

        The close status that must match the close status of an execution for it to meet the criteria of this filter.

        Possible values include:
        • "COMPLETED"
        • "FAILED"
        • "CANCELED"
        • "TERMINATED"
        • "CONTINUED_AS_NEW"
        • "TIMED_OUT"

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:

      • count — (Integer)

        The number of workflow executions.

      • truncated — (Boolean)

        If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the countOpenWorkflowExecutions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  startTimeFilter: { /* required */
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  executionFilter: {
    workflowId: 'STRING_VALUE' /* required */
  },
  tagFilter: {
    tag: 'STRING_VALUE' /* required */
  },
  typeFilter: {
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE'
  }
};
swf.countOpenWorkflowExecutions(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow executions to count.

    • startTimeFilter — (map)

      Specifies the start time criteria that workflow executions must meet in order to be counted.

      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • typeFilter — (map)

      Specifies the type of the workflow executions to be counted.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • name — required — (String)

        Name of the workflow type.

      • version — (String)

        Version of the workflow type.

    • tagFilter — (map)

      If specified, only executions that have a tag that matches the filter are counted.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • tag — required — (String)

        Specifies the tag that must be associated with the execution for it to meet the filter criteria.

        Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    • executionFilter — (map)

      If specified, only workflow executions matching the WorkflowId in the filter are counted.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • workflowId — required — (String)

        The workflowId to pass of match the criteria of this filter.

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:

      • count — (Integer)

        The number of workflow executions.

      • truncated — (Boolean)

        If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the countPendingActivityTasks operation

var params = {
  domain: 'STRING_VALUE', /* required */
  taskList: { /* required */
    name: 'STRING_VALUE' /* required */
  }
};
swf.countPendingActivityTasks(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: {}) —
    • domain — (String)

      The name of the domain that contains the task list.

    • taskList — (map)

      The name of the task list.

      • name — required — (String)

        The name of the task list.

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:

      • count — (Integer)

        The number of tasks in the task list.

      • truncated — (Boolean)

        If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the countPendingDecisionTasks operation

var params = {
  domain: 'STRING_VALUE', /* required */
  taskList: { /* required */
    name: 'STRING_VALUE' /* required */
  }
};
swf.countPendingDecisionTasks(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: {}) —
    • domain — (String)

      The name of the domain that contains the task list.

    • taskList — (map)

      The name of the task list.

      • name — required — (String)

        The name of the task list.

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:

      • count — (Integer)

        The number of tasks in the task list.

      • truncated — (Boolean)

        If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • activityType.name: String constraint. The key is swf:activityType.name.

    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the deprecateActivityType operation

var params = {
  activityType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  domain: 'STRING_VALUE' /* required */
};
swf.deprecateActivityType(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: {}) —
    • domain — (String)

      The name of the domain in which the activity type is registered.

    • activityType — (map)

      The activity type to deprecate.

      • name — required — (String)

        The name of this activity.

        Note: The combination of activity type name and version must be unique within a domain.
      • version — required — (String)

        The version of this activity.

        Note: The combination of activity type name and version must be unique with in a domain.

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.

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

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the deprecateDomain operation

var params = {
  name: 'STRING_VALUE' /* required */
};
swf.deprecateDomain(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 domain to deprecate.

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.

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

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the deprecateWorkflowType operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  }
};
swf.deprecateWorkflowType(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: {}) —
    • domain — (String)

      The name of the domain in which the workflow type is registered.

    • workflowType — (map)

      The workflow type to deprecate.

      • name — required — (String)

        The name of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.
      • version — required — (String)

        The version of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.

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.

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

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • activityType.name: String constraint. The key is swf:activityType.name.

    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the describeActivityType operation

var params = {
  activityType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  domain: 'STRING_VALUE' /* required */
};
swf.describeActivityType(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: {}) —
    • domain — (String)

      The name of the domain in which the activity type is registered.

    • activityType — (map)

      The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

      • name — required — (String)

        The name of this activity.

        Note: The combination of activity type name and version must be unique within a domain.
      • version — required — (String)

        The version of this activity.

        Note: The combination of activity type name and version must be unique with in a domain.

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:

      • typeInfo — (map)

        General information about the activity type.

        The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

        • REGISTERED – The type is registered and available. Workers supporting this type should be running.

        • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

        • activityType — required — (map)

          The ActivityType type structure representing the activity type.

          • name — required — (String)

            The name of this activity.

            Note: The combination of activity type name and version must be unique within a domain.
          • version — required — (String)

            The version of this activity.

            Note: The combination of activity type name and version must be unique with in a domain.
        • status — required — (String)

          The current status of the activity type.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the activity type provided in RegisterActivityType.

        • creationDate — required — (Date)

          The date and time this activity type was created through RegisterActivityType.

        • deprecationDate — (Date)

          If DEPRECATED, the date and time DeprecateActivityType was called.

      • configuration — (map)

        The configuration settings registered with the activity type.

        • defaultTaskStartToCloseTimeout — (String)

          The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • defaultTaskHeartbeatTimeout — (String)

          The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

          You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • defaultTaskList — (map)

          The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.

          • name — required — (String)

            The name of the task list.

        • defaultTaskPriority — (String)

          The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.

          Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • defaultTaskScheduleToStartTimeout — (String)

          The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • defaultTaskScheduleToCloseTimeout — (String)

          The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the describeDomain operation

var params = {
  name: 'STRING_VALUE' /* required */
};
swf.describeDomain(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 domain 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:

      • domainInfo — (map)

        The basic information about a domain, such as its name, status, and description.

        • name — required — (String)

          The name of the domain. This name is unique within the account.

        • status — required — (String)

          The status of the domain:

          • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

          • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the domain provided through RegisterDomain.

        • arn — (String)

          The ARN of the domain.

      • configuration — (map)

        The domain configuration. Currently, this includes only the domain's retention period.

        • workflowExecutionRetentionPeriodInDays — required — (String)

          The retention period for workflow executions in this domain.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified workflow execution including its type and some statistics.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the describeWorkflowExecution operation

var params = {
  domain: 'STRING_VALUE', /* required */
  execution: { /* required */
    runId: 'STRING_VALUE', /* required */
    workflowId: 'STRING_VALUE' /* required */
  }
};
swf.describeWorkflowExecution(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow execution.

    • execution — (map)

      The workflow execution to describe.

      • workflowId — required — (String)

        The user defined identifier associated with the workflow execution.

      • runId — required — (String)

        A system-generated unique identifier for the workflow execution.

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:

      • executionInfo — (map)

        Information about the workflow execution.

        • execution — required — (map)

          The workflow execution this information is about.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • workflowType — required — (map)

          The type of the workflow execution.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • startTimestamp — required — (Date)

          The time when the execution was started.

        • closeTimestamp — (Date)

          The time when the workflow execution was closed. Set only if the execution status is CLOSED.

        • executionStatus — required — (String)

          The current status of the execution.

          Possible values include:
          • "OPEN"
          • "CLOSED"
        • closeStatus — (String)

          If the execution status is closed then this specifies how the execution was closed:

          • COMPLETED – the execution was successfully completed.

          • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

          • TERMINATED – the execution was force terminated.

          • FAILED – the execution failed to complete.

          • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

          • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

          Possible values include:
          • "COMPLETED"
          • "FAILED"
          • "CANCELED"
          • "TERMINATED"
          • "CONTINUED_AS_NEW"
          • "TIMED_OUT"
        • parent — (map)

          If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • tagList — (Array<String>)

          The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

        • cancelRequested — (Boolean)

          Set to true if a cancellation is requested for this workflow execution.

      • executionConfiguration — (map)

        The configuration settings for this workflow execution including timeout values, tasklist etc.

        • taskStartToCloseTimeout — required — (String)

          The maximum duration allowed for decision tasks for this workflow execution.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • executionStartToCloseTimeout — required — (String)

          The total duration for this workflow execution.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • taskList — required — (map)

          The task list used for the decision tasks generated for this workflow execution.

          • name — required — (String)

            The name of the task list.

        • taskPriority — (String)

          The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • childPolicy — required — (String)

          The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

          The supported child policies are:

          • TERMINATE – The child executions are terminated.

          • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

          • ABANDON – No action is taken. The child executions continue to run.

          Possible values include:
          • "TERMINATE"
          • "REQUEST_CANCEL"
          • "ABANDON"
        • lambdaRole — (String)

          The IAM role attached to the child workflow execution.

      • openCounts — (map)

        The number of tasks for this workflow execution. This includes open and closed tasks of all types.

        • openActivityTasks — required — (Integer)

          The count of activity tasks whose status is OPEN.

        • openDecisionTasks — required — (Integer)

          The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

        • openTimers — required — (Integer)

          The count of timers started by this workflow execution that have not fired yet.

        • openChildWorkflowExecutions — required — (Integer)

          The count of child workflow executions whose status is OPEN.

        • openLambdaFunctions — (Integer)

          The count of Lambda tasks whose status is OPEN.

      • latestActivityTaskTimestamp — (Date)

        The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

      • latestExecutionContext — (String)

        The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the describeWorkflowType operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  }
};
swf.describeWorkflowType(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: {}) —
    • domain — (String)

      The name of the domain in which this workflow type is registered.

    • workflowType — (map)

      The workflow type to describe.

      • name — required — (String)

        The name of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.
      • version — required — (String)

        The version of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.

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:

      • typeInfo — (map)

        General information about the workflow type.

        The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

        • REGISTERED – The type is registered and available. Workers supporting this type should be running.

        • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

        • workflowType — required — (map)

          The workflow type this information is about.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • status — required — (String)

          The current status of the workflow type.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the type registered through RegisterWorkflowType.

        • creationDate — required — (Date)

          The date when this type was registered.

        • deprecationDate — (Date)

          If the type is in deprecated state, then it is set to the date when the type was deprecated.

      • configuration — (map)

        Configuration settings of the workflow type registered through RegisterWorkflowType

        • defaultTaskStartToCloseTimeout — (String)

          The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • defaultExecutionStartToCloseTimeout — (String)

          The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • defaultTaskList — (map)

          The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

          • name — required — (String)

            The name of the task list.

        • defaultTaskPriority — (String)

          The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • defaultChildPolicy — (String)

          The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

          The supported child policies are:

          • TERMINATE – The child executions are terminated.

          • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

          • ABANDON – No action is taken. The child executions continue to run.

          Possible values include:
          • "TERMINATE"
          • "REQUEST_CANCEL"
          • "ABANDON"
        • defaultLambdaRole — (String)

          The default IAM role attached to this workflow type.

          Note: Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the getWorkflowExecutionHistory operation

var params = {
  domain: 'STRING_VALUE', /* required */
  execution: { /* required */
    runId: 'STRING_VALUE', /* required */
    workflowId: 'STRING_VALUE' /* required */
  },
  maximumPageSize: 'NUMBER_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false
};
swf.getWorkflowExecutionHistory(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow execution.

    • execution — (map)

      Specifies the workflow execution for which to return the history.

      • workflowId — required — (String)

        The user defined identifier associated with the workflow execution.

      • runId — required — (String)

        A system-generated unique identifier for the workflow execution.

    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

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 history events.

        • eventTimestamp — required — (Date)

          The date and time when the event occurred.

        • eventType — required — (String)

          The type of the history event.

          Possible values include:
          • "WorkflowExecutionStarted"
          • "WorkflowExecutionCancelRequested"
          • "WorkflowExecutionCompleted"
          • "CompleteWorkflowExecutionFailed"
          • "WorkflowExecutionFailed"
          • "FailWorkflowExecutionFailed"
          • "WorkflowExecutionTimedOut"
          • "WorkflowExecutionCanceled"
          • "CancelWorkflowExecutionFailed"
          • "WorkflowExecutionContinuedAsNew"
          • "ContinueAsNewWorkflowExecutionFailed"
          • "WorkflowExecutionTerminated"
          • "DecisionTaskScheduled"
          • "DecisionTaskStarted"
          • "DecisionTaskCompleted"
          • "DecisionTaskTimedOut"
          • "ActivityTaskScheduled"
          • "ScheduleActivityTaskFailed"
          • "ActivityTaskStarted"
          • "ActivityTaskCompleted"
          • "ActivityTaskFailed"
          • "ActivityTaskTimedOut"
          • "ActivityTaskCanceled"
          • "ActivityTaskCancelRequested"
          • "RequestCancelActivityTaskFailed"
          • "WorkflowExecutionSignaled"
          • "MarkerRecorded"
          • "RecordMarkerFailed"
          • "TimerStarted"
          • "StartTimerFailed"
          • "TimerFired"
          • "TimerCanceled"
          • "CancelTimerFailed"
          • "StartChildWorkflowExecutionInitiated"
          • "StartChildWorkflowExecutionFailed"
          • "ChildWorkflowExecutionStarted"
          • "ChildWorkflowExecutionCompleted"
          • "ChildWorkflowExecutionFailed"
          • "ChildWorkflowExecutionTimedOut"
          • "ChildWorkflowExecutionCanceled"
          • "ChildWorkflowExecutionTerminated"
          • "SignalExternalWorkflowExecutionInitiated"
          • "SignalExternalWorkflowExecutionFailed"
          • "ExternalWorkflowExecutionSignaled"
          • "RequestCancelExternalWorkflowExecutionInitiated"
          • "RequestCancelExternalWorkflowExecutionFailed"
          • "ExternalWorkflowExecutionCancelRequested"
          • "LambdaFunctionScheduled"
          • "LambdaFunctionStarted"
          • "LambdaFunctionCompleted"
          • "LambdaFunctionFailed"
          • "LambdaFunctionTimedOut"
          • "ScheduleLambdaFunctionFailed"
          • "StartLambdaFunctionFailed"
        • eventId — required — (Integer)

          The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

        • workflowExecutionStartedEventAttributes — (map)

          If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • input — (String)

            The input provided to the workflow execution.

          • executionStartToCloseTimeout — (String)

            The maximum duration for this workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskStartToCloseTimeout — (String)

            The maximum duration of decision tasks for this workflow type.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • taskList — required — (map)

            The name of the task list for scheduling the decision tasks for this workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority of the decision tasks in the workflow execution.

          • workflowType — required — (map)

            The workflow type of this execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • tagList — (Array<String>)

            The list of tags associated with this workflow execution. An execution can have up to 5 tags.

          • continuedExecutionRunId — (String)

            If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

          • parentWorkflowExecution — (map)

            The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • parentInitiatedEventId — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • lambdaRole — (String)

            The IAM role attached to the workflow execution.

        • workflowExecutionCompletedEventAttributes — (map)

          If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • result — (String)

            The result produced by the workflow execution upon successful completion.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • completeWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionFailedEventAttributes — (map)

          If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The descriptive reason provided for the failure.

          • details — (String)

            The details of the failure.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • failWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionTimedOutEventAttributes — (map)

          If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
          • childPolicy — required — (String)

            The policy used for the child workflow executions of this workflow execution.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
        • workflowExecutionCanceledEventAttributes — (map)

          If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • details — (String)

            The details of the cancellation.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • cancelWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionContinuedAsNewEventAttributes — (map)

          If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.

          • input — (String)

            The input provided to the new workflow execution.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • newExecutionRunId — required — (String)

            The runId of the new workflow execution.

          • executionStartToCloseTimeout — (String)

            The total duration allowed for the new workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskList — required — (map)

            The task list to use for the decisions of the new (continued) workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority of the task to use for the decisions of the new (continued) workflow execution.

          • taskStartToCloseTimeout — (String)

            The maximum duration of decision tasks for the new workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • tagList — (Array<String>)

            The list of tags associated with the new workflow execution.

          • workflowType — required — (map)

            The workflow type of this execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • lambdaRole — (String)

            The IAM role to attach to the new (continued) workflow execution.

        • continueAsNewWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "WORKFLOW_TYPE_DEPRECATED"
            • "WORKFLOW_TYPE_DOES_NOT_EXIST"
            • "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_CHILD_POLICY_UNDEFINED"
            • "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionTerminatedEventAttributes — (map)

          If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The reason provided for the termination.

          • details — (String)

            The details provided for the termination.

          • childPolicy — required — (String)

            The policy used for the child workflow executions of this workflow execution.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • cause — (String)

            If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

            Possible values include:
            • "CHILD_POLICY_APPLIED"
            • "EVENT_LIMIT_EXCEEDED"
            • "OPERATOR_INITIATED"
        • workflowExecutionCancelRequestedEventAttributes — (map)

          If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • externalWorkflowExecution — (map)

            The external workflow execution for which the cancellation was requested.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • externalInitiatedEventId — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • cause — (String)

            If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

            Possible values include:
            • "CHILD_POLICY_APPLIED"
        • decisionTaskScheduledEventAttributes — (map)

          If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • taskList — required — (map)

            The name of the task list in which the decision task was scheduled.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • startToCloseTimeout — (String)

            The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • decisionTaskStartedEventAttributes — (map)

          If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • identity — (String)

            Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • decisionTaskCompletedEventAttributes — (map)

          If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • executionContext — (String)

            User defined context for the workflow execution.

          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • decisionTaskTimedOutEventAttributes — (map)

          If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of timeout that expired before the decision task could be completed.

            Possible values include:
            • "START_TO_CLOSE"
          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskScheduledEventAttributes — (map)

          If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityType — required — (map)

            The type of the activity task.

            • name — required — (String)

              The name of this activity.

              Note: The combination of activity type name and version must be unique within a domain.
            • version — required — (String)

              The version of this activity.

              Note: The combination of activity type name and version must be unique with in a domain.
          • activityId — required — (String)

            The unique ID of the activity task.

          • input — (String)

            The input provided to the activity task.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

          • scheduleToStartTimeout — (String)

            The maximum amount of time the activity task can wait to be assigned to a worker.

          • scheduleToCloseTimeout — (String)

            The maximum amount of time for this activity task.

          • startToCloseTimeout — (String)

            The maximum amount of time a worker may take to process the activity task.

          • taskList — required — (map)

            The task list in which the activity task has been scheduled.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

            Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • heartbeatTimeout — (String)

            The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

        • activityTaskStartedEventAttributes — (map)

          If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • identity — (String)

            Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskCompletedEventAttributes — (map)

          If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • result — (String)

            The results of the activity task.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskFailedEventAttributes — (map)

          If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The reason provided for the failure.

          • details — (String)

            The details of the failure.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskTimedOutEventAttributes — (map)

          If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of the timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
            • "SCHEDULE_TO_START"
            • "SCHEDULE_TO_CLOSE"
            • "HEARTBEAT"
          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • details — (String)

            Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

        • activityTaskCanceledEventAttributes — (map)

          If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • details — (String)

            Details of the cancellation.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • latestCancelRequestedEventId — (Integer)

            If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskCancelRequestedEventAttributes — (map)

          If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • activityId — required — (String)

            The unique ID of the task.

        • workflowExecutionSignaledEventAttributes — (map)

          If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • signalName — required — (String)

            The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

          • input — (String)

            The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

          • externalWorkflowExecution — (map)

            The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • externalInitiatedEventId — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

        • markerRecordedEventAttributes — (map)

          If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.

          • markerName — required — (String)

            The name of the marker.

          • details — (String)

            The details of the marker.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • recordMarkerFailedEventAttributes — (map)

          If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • markerName — required — (String)

            The marker's name.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerStartedEventAttributes — (map)

          If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that was started.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks.

          • startToFireTimeout — required — (String)

            The duration of time after which the timer fires.

            The duration is specified in seconds, an integer greater than or equal to 0.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerFiredEventAttributes — (map)

          If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that fired.

          • startedEventId — required — (Integer)

            The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerCanceledEventAttributes — (map)

          If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that was canceled.

          • startedEventId — required — (Integer)

            The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startChildWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the child workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • control — (String)

            Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

          • input — (String)

            The inputs provided to the child workflow execution.

          • executionStartToCloseTimeout — (String)

            The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskList — required — (map)

            The name of the task list used for the decision tasks of the child workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • taskStartToCloseTimeout — (String)

            The maximum duration allowed for the decision tasks for this workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • tagList — (Array<String>)

            The list of tags to associated with the child workflow execution.

          • lambdaRole — (String)

            The IAM role to attach to the child workflow execution.

        • childWorkflowExecutionStartedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was started.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionCompletedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was completed.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • result — (String)

            The result of the child workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that failed.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • reason — (String)

            The reason for the failure (if provided).

          • details — (String)

            The details of the failure (if provided).

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionTimedOutEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that timed out.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • timeoutType — required — (String)

            The type of the timeout that caused the child workflow execution to time out.

            Possible values include:
            • "START_TO_CLOSE"
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionCanceledEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was canceled.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • details — (String)

            Details of the cancellation (if provided).

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionTerminatedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was terminated.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • signalExternalWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution.

          • runId — (String)

            The runId of the external workflow execution to send the signal to.

          • signalName — required — (String)

            The name of the signal.

          • input — (String)

            The input provided to the signal.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent decision tasks.

        • externalWorkflowExecutionSignaledEventAttributes — (map)

          If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The external workflow execution that the signal was delivered to.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • signalExternalWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution that the signal was being delivered to.

          • runId — (String)

            The runId of the external workflow execution that the signal was being delivered to.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"
            • "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • initiatedEventId — required — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

        • externalWorkflowExecutionCancelRequestedEventAttributes — (map)

          If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The external workflow execution to which the cancellation request was delivered.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • requestCancelExternalWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution to be canceled.

          • runId — (String)

            The runId of the external workflow execution to be canceled.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • requestCancelExternalWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow to which the cancel request was to be delivered.

          • runId — (String)

            The runId of the external workflow execution.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"
            • "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • initiatedEventId — required — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

        • scheduleActivityTaskFailedEventAttributes — (map)

          If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityType — required — (map)

            The activity type provided in the ScheduleActivityTask decision that failed.

            • name — required — (String)

              The name of this activity.

              Note: The combination of activity type name and version must be unique within a domain.
            • version — required — (String)

              The version of this activity.

              Note: The combination of activity type name and version must be unique with in a domain.
          • activityId — required — (String)

            The activityId provided in the ScheduleActivityTask decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ACTIVITY_TYPE_DEPRECATED"
            • "ACTIVITY_TYPE_DOES_NOT_EXIST"
            • "ACTIVITY_ID_ALREADY_IN_USE"
            • "OPEN_ACTIVITIES_LIMIT_EXCEEDED"
            • "ACTIVITY_CREATION_RATE_EXCEEDED"
            • "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED"
            • "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • requestCancelActivityTaskFailedEventAttributes — (map)

          If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityId — required — (String)

            The activityId provided in the RequestCancelActivityTask decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ACTIVITY_ID_UNKNOWN"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startTimerFailedEventAttributes — (map)

          If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The timerId provided in the StartTimer decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "TIMER_ID_ALREADY_IN_USE"
            • "OPEN_TIMERS_LIMIT_EXCEEDED"
            • "TIMER_CREATION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • cancelTimerFailedEventAttributes — (map)

          If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The timerId provided in the CancelTimer decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "TIMER_ID_UNKNOWN"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startChildWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowType — required — (map)

            The workflow type provided in the StartChildWorkflowExecution Decision that failed.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "WORKFLOW_TYPE_DOES_NOT_EXIST"
            • "WORKFLOW_TYPE_DEPRECATED"
            • "OPEN_CHILDREN_LIMIT_EXCEEDED"
            • "OPEN_WORKFLOWS_LIMIT_EXCEEDED"
            • "CHILD_CREATION_RATE_EXCEEDED"
            • "WORKFLOW_ALREADY_RUNNING"
            • "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_CHILD_POLICY_UNDEFINED"
            • "OPERATION_NOT_PERMITTED"
          • workflowId — required — (String)

            The workflowId of the child workflow execution.

          • initiatedEventId — required — (Integer)

            When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.

            When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.

        • lambdaFunctionScheduledEventAttributes — (map)

          Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

          • id — required — (String)

            The unique ID of the Lambda task.

          • name — required — (String)

            The name of the Lambda function.

          • control — (String)

            Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

          • input — (String)

            The input provided to the Lambda task.

          • startToCloseTimeout — (String)

            The maximum amount of time a worker can take to process the Lambda task.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • lambdaFunctionStartedEventAttributes — (map)

          Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • lambdaFunctionCompletedEventAttributes — (map)

          Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • result — (String)

            The results of the Lambda task.

        • lambdaFunctionFailedEventAttributes — (map)

          Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • reason — (String)

            The reason provided for the failure.

          • details — (String)

            The details of the failure.

        • lambdaFunctionTimedOutEventAttributes — (map)

          Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • timeoutType — (String)

            The type of the timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
        • scheduleLambdaFunctionFailedEventAttributes — (map)

          Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

          • id — required — (String)

            The ID provided in the ScheduleLambdaFunction decision that failed.

          • name — required — (String)

            The name of the Lambda function.

          • cause — required — (String)

            The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ID_ALREADY_IN_USE"
            • "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"
            • "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"
            • "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • startLambdaFunctionFailedEventAttributes — (map)

          Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

          • scheduledEventId — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • cause — (String)

            The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.
            Possible values include:
            • "ASSUME_ROLE_FAILED"
          • message — (String)

            A description that can help diagnose the cause of the fault.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the listActivityTypes operation

var params = {
  domain: 'STRING_VALUE', /* required */
  registrationStatus: REGISTERED | DEPRECATED, /* required */
  maximumPageSize: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false
};
swf.listActivityTypes(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: {}) —
    • domain — (String)

      The name of the domain in which the activity types have been registered.

    • name — (String)

      If specified, only lists the activity types that have this name.

    • registrationStatus — (String)

      Specifies the registration status of the activity types to list.

      Possible values include:
      • "REGISTERED"
      • "DEPRECATED"
    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

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:

      • typeInfos — (Array<map>)

        List of activity type information.

        • activityType — required — (map)

          The ActivityType type structure representing the activity type.

          • name — required — (String)

            The name of this activity.

            Note: The combination of activity type name and version must be unique within a domain.
          • version — required — (String)

            The version of this activity.

            Note: The combination of activity type name and version must be unique with in a domain.
        • status — required — (String)

          The current status of the activity type.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the activity type provided in RegisterActivityType.

        • creationDate — required — (Date)

          The date and time this activity type was created through RegisterActivityType.

        • deprecationDate — (Date)

          If DEPRECATED, the date and time DeprecateActivityType was called.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the listClosedWorkflowExecutions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  closeStatusFilter: {
    status: COMPLETED | FAILED | CANCELED | TERMINATED | CONTINUED_AS_NEW | TIMED_OUT /* required */
  },
  closeTimeFilter: {
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  executionFilter: {
    workflowId: 'STRING_VALUE' /* required */
  },
  maximumPageSize: 'NUMBER_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false,
  startTimeFilter: {
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  tagFilter: {
    tag: 'STRING_VALUE' /* required */
  },
  typeFilter: {
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE'
  }
};
swf.listClosedWorkflowExecutions(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: {}) —
    • domain — (String)

      The name of the domain that contains the workflow executions to list.

    • startTimeFilter — (map)

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      Note: startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • closeTimeFilter — (map)

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      Note: startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • executionFilter — (map)

      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • workflowId — required — (String)

        The workflowId to pass of match the criteria of this filter.

    • closeStatusFilter — (map)

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • status — required — (String)

        The close status that must match the close status of an execution for it to meet the criteria of this filter.

        Possible values include:
        • "COMPLETED"
        • "FAILED"
        • "CANCELED"
        • "TERMINATED"
        • "CONTINUED_AS_NEW"
        • "TIMED_OUT"
    • typeFilter — (map)

      If specified, only executions of the type specified in the filter are returned.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • name — required — (String)

        Name of the workflow type.

      • version — (String)

        Version of the workflow type.

    • tagFilter — (map)

      If specified, only executions that have the matching tag are listed.

      Note: closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • tag — required — (String)

        Specifies the tag that must be associated with the execution for it to meet the filter criteria.

        Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

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:

      • executionInfos — (Array<map>)

        The list of workflow information structures.

        • execution — required — (map)

          The workflow execution this information is about.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • workflowType — required — (map)

          The type of the workflow execution.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • startTimestamp — required — (Date)

          The time when the execution was started.

        • closeTimestamp — (Date)

          The time when the workflow execution was closed. Set only if the execution status is CLOSED.

        • executionStatus — required — (String)

          The current status of the execution.

          Possible values include:
          • "OPEN"
          • "CLOSED"
        • closeStatus — (String)

          If the execution status is closed then this specifies how the execution was closed:

          • COMPLETED – the execution was successfully completed.

          • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

          • TERMINATED – the execution was force terminated.

          • FAILED – the execution failed to complete.

          • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

          • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

          Possible values include:
          • "COMPLETED"
          • "FAILED"
          • "CANCELED"
          • "TERMINATED"
          • "CONTINUED_AS_NEW"
          • "TIMED_OUT"
        • parent — (map)

          If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • tagList — (Array<String>)

          The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

        • cancelRequested — (Boolean)

          Set to true if a cancellation is requested for this workflow execution.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  registrationStatus: REGISTERED | DEPRECATED, /* required */
  maximumPageSize: 'NUMBER_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false
};
swf.listDomains(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: {}) —
    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • registrationStatus — (String)

      Specifies the registration status of the domains to list.

      Possible values include:
      • "REGISTERED"
      • "DEPRECATED"
    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

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:

      • domainInfos — (Array<map>)

        A list of DomainInfo structures.

        • name — required — (String)

          The name of the domain. This name is unique within the account.

        • status — required — (String)

          The status of the domain:

          • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

          • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the domain provided through RegisterDomain.

        • arn — (String)

          The ARN of the domain.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the listOpenWorkflowExecutions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  startTimeFilter: { /* required */
    oldestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    latestDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  executionFilter: {
    workflowId: 'STRING_VALUE' /* required */
  },
  maximumPageSize: 'NUMBER_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false,
  tagFilter: {
    tag: 'STRING_VALUE' /* required */
  },
  typeFilter: {
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE'
  }
};
swf.listOpenWorkflowExecutions(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: {}) —
    • domain — (String)

      The name of the domain that contains the workflow executions to list.

    • startTimeFilter — (map)

      Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

      • oldestDate — required — (Date)

        Specifies the oldest start or close date and time to return.

      • latestDate — (Date)

        Specifies the latest start or close date and time to return.

    • typeFilter — (map)

      If specified, only executions of the type specified in the filter are returned.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • name — required — (String)

        Name of the workflow type.

      • version — (String)

        Version of the workflow type.

    • tagFilter — (map)

      If specified, only executions that have the matching tag are listed.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • tag — required — (String)

        Specifies the tag that must be associated with the execution for it to meet the filter criteria.

        Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

    • executionFilter — (map)

      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      Note: executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
      • workflowId — required — (String)

        The workflowId to pass of match the criteria of this filter.

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:

      • executionInfos — (Array<map>)

        The list of workflow information structures.

        • execution — required — (map)

          The workflow execution this information is about.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • workflowType — required — (map)

          The type of the workflow execution.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • startTimestamp — required — (Date)

          The time when the execution was started.

        • closeTimestamp — (Date)

          The time when the workflow execution was closed. Set only if the execution status is CLOSED.

        • executionStatus — required — (String)

          The current status of the execution.

          Possible values include:
          • "OPEN"
          • "CLOSED"
        • closeStatus — (String)

          If the execution status is closed then this specifies how the execution was closed:

          • COMPLETED – the execution was successfully completed.

          • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

          • TERMINATED – the execution was force terminated.

          • FAILED – the execution failed to complete.

          • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

          • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

          Possible values include:
          • "COMPLETED"
          • "FAILED"
          • "CANCELED"
          • "TERMINATED"
          • "CONTINUED_AS_NEW"
          • "TIMED_OUT"
        • parent — (map)

          If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

          • workflowId — required — (String)

            The user defined identifier associated with the workflow execution.

          • runId — required — (String)

            A system-generated unique identifier for the workflow execution.

        • tagList — (Array<String>)

          The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

        • cancelRequested — (Boolean)

          Set to true if a cancellation is requested for this workflow execution.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

List tags for a given domain.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
swf.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 Amazon SWF domain.

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 domain.

        • key — required — (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.

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

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the listWorkflowTypes operation

var params = {
  domain: 'STRING_VALUE', /* required */
  registrationStatus: REGISTERED | DEPRECATED, /* required */
  maximumPageSize: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false
};
swf.listWorkflowTypes(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: {}) —
    • domain — (String)

      The name of the domain in which the workflow types have been registered.

    • name — (String)

      If specified, lists the workflow type with this name.

    • registrationStatus — (String)

      Specifies the registration status of the workflow types to list.

      Possible values include:
      • "REGISTERED"
      • "DEPRECATED"
    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder — (Boolean)

      When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

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:

      • typeInfos — (Array<map>)

        The list of workflow type information.

        • workflowType — required — (map)

          The workflow type this information is about.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • status — required — (String)

          The current status of the workflow type.

          Possible values include:
          • "REGISTERED"
          • "DEPRECATED"
        • description — (String)

          The description of the type registered through RegisterWorkflowType.

        • creationDate — required — (Date)

          The date when this type was registered.

        • deprecationDate — (Date)

          If the type is in deprecated state, then it is set to the date when the type was deprecated.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. 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 an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the pollForActivityTask operation

var params = {
  domain: 'STRING_VALUE', /* required */
  taskList: { /* required */
    name: 'STRING_VALUE' /* required */
  },
  identity: 'STRING_VALUE'
};
swf.pollForActivityTask(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: {}) —
    • domain — (String)

      The name of the domain that contains the task lists being polled.

    • taskList — (map)

      Specifies the task list to poll for activity tasks.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

      • name — required — (String)

        The name of the task list.

    • identity — (String)

      Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

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)

        The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

      • activityId — (String)

        The unique ID of the task.

      • startedEventId — (Integer)

        The ID of the ActivityTaskStarted event recorded in the history.

      • workflowExecution — (map)

        The workflow execution that started this activity task.

        • workflowId — required — (String)

          The user defined identifier associated with the workflow execution.

        • runId — required — (String)

          A system-generated unique identifier for the workflow execution.

      • activityType — (map)

        The type of this activity task.

        • name — required — (String)

          The name of this activity.

          Note: The combination of activity type name and version must be unique within a domain.
        • version — required — (String)

          The version of this activity.

          Note: The combination of activity type name and version must be unique with in a domain.
      • input — (String)

        The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the pollForDecisionTask operation

var params = {
  domain: 'STRING_VALUE', /* required */
  taskList: { /* required */
    name: 'STRING_VALUE' /* required */
  },
  identity: 'STRING_VALUE',
  maximumPageSize: 'NUMBER_VALUE',
  nextPageToken: 'STRING_VALUE',
  reverseOrder: true || false
};
swf.pollForDecisionTask(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: {}) —
    • domain — (String)

      The name of the domain containing the task lists to poll.

    • taskList — (map)

      Specifies the task list to poll for decision tasks.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

      • name — required — (String)

        The name of the task list.

    • identity — (String)

      Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    • nextPageToken — (String)

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

      Note: The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.
    • maximumPageSize — (Integer)

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

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

    • reverseOrder — (Boolean)

      When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

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)

        The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

      • startedEventId — (Integer)

        The ID of the DecisionTaskStarted event recorded in the history.

      • workflowExecution — (map)

        The workflow execution for which this decision task was created.

        • workflowId — required — (String)

          The user defined identifier associated with the workflow execution.

        • runId — required — (String)

          A system-generated unique identifier for the workflow execution.

      • workflowType — (map)

        The type of the workflow execution for which this decision task was created.

        • name — required — (String)

          The name of the workflow type.

          Note: The combination of workflow type name and version must be unique with in a domain.
        • version — required — (String)

          The version of the workflow type.

          Note: The combination of workflow type name and version must be unique with in a domain.
      • events — (Array<map>)

        A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

        • eventTimestamp — required — (Date)

          The date and time when the event occurred.

        • eventType — required — (String)

          The type of the history event.

          Possible values include:
          • "WorkflowExecutionStarted"
          • "WorkflowExecutionCancelRequested"
          • "WorkflowExecutionCompleted"
          • "CompleteWorkflowExecutionFailed"
          • "WorkflowExecutionFailed"
          • "FailWorkflowExecutionFailed"
          • "WorkflowExecutionTimedOut"
          • "WorkflowExecutionCanceled"
          • "CancelWorkflowExecutionFailed"
          • "WorkflowExecutionContinuedAsNew"
          • "ContinueAsNewWorkflowExecutionFailed"
          • "WorkflowExecutionTerminated"
          • "DecisionTaskScheduled"
          • "DecisionTaskStarted"
          • "DecisionTaskCompleted"
          • "DecisionTaskTimedOut"
          • "ActivityTaskScheduled"
          • "ScheduleActivityTaskFailed"
          • "ActivityTaskStarted"
          • "ActivityTaskCompleted"
          • "ActivityTaskFailed"
          • "ActivityTaskTimedOut"
          • "ActivityTaskCanceled"
          • "ActivityTaskCancelRequested"
          • "RequestCancelActivityTaskFailed"
          • "WorkflowExecutionSignaled"
          • "MarkerRecorded"
          • "RecordMarkerFailed"
          • "TimerStarted"
          • "StartTimerFailed"
          • "TimerFired"
          • "TimerCanceled"
          • "CancelTimerFailed"
          • "StartChildWorkflowExecutionInitiated"
          • "StartChildWorkflowExecutionFailed"
          • "ChildWorkflowExecutionStarted"
          • "ChildWorkflowExecutionCompleted"
          • "ChildWorkflowExecutionFailed"
          • "ChildWorkflowExecutionTimedOut"
          • "ChildWorkflowExecutionCanceled"
          • "ChildWorkflowExecutionTerminated"
          • "SignalExternalWorkflowExecutionInitiated"
          • "SignalExternalWorkflowExecutionFailed"
          • "ExternalWorkflowExecutionSignaled"
          • "RequestCancelExternalWorkflowExecutionInitiated"
          • "RequestCancelExternalWorkflowExecutionFailed"
          • "ExternalWorkflowExecutionCancelRequested"
          • "LambdaFunctionScheduled"
          • "LambdaFunctionStarted"
          • "LambdaFunctionCompleted"
          • "LambdaFunctionFailed"
          • "LambdaFunctionTimedOut"
          • "ScheduleLambdaFunctionFailed"
          • "StartLambdaFunctionFailed"
        • eventId — required — (Integer)

          The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

        • workflowExecutionStartedEventAttributes — (map)

          If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • input — (String)

            The input provided to the workflow execution.

          • executionStartToCloseTimeout — (String)

            The maximum duration for this workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskStartToCloseTimeout — (String)

            The maximum duration of decision tasks for this workflow type.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • taskList — required — (map)

            The name of the task list for scheduling the decision tasks for this workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority of the decision tasks in the workflow execution.

          • workflowType — required — (map)

            The workflow type of this execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • tagList — (Array<String>)

            The list of tags associated with this workflow execution. An execution can have up to 5 tags.

          • continuedExecutionRunId — (String)

            If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

          • parentWorkflowExecution — (map)

            The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • parentInitiatedEventId — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • lambdaRole — (String)

            The IAM role attached to the workflow execution.

        • workflowExecutionCompletedEventAttributes — (map)

          If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • result — (String)

            The result produced by the workflow execution upon successful completion.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • completeWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionFailedEventAttributes — (map)

          If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The descriptive reason provided for the failure.

          • details — (String)

            The details of the failure.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • failWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionTimedOutEventAttributes — (map)

          If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
          • childPolicy — required — (String)

            The policy used for the child workflow executions of this workflow execution.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
        • workflowExecutionCanceledEventAttributes — (map)

          If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • details — (String)

            The details of the cancellation.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • cancelWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionContinuedAsNewEventAttributes — (map)

          If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.

          • input — (String)

            The input provided to the new workflow execution.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • newExecutionRunId — required — (String)

            The runId of the new workflow execution.

          • executionStartToCloseTimeout — (String)

            The total duration allowed for the new workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskList — required — (map)

            The task list to use for the decisions of the new (continued) workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority of the task to use for the decisions of the new (continued) workflow execution.

          • taskStartToCloseTimeout — (String)

            The maximum duration of decision tasks for the new workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • tagList — (Array<String>)

            The list of tags associated with the new workflow execution.

          • workflowType — required — (map)

            The workflow type of this execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • lambdaRole — (String)

            The IAM role to attach to the new (continued) workflow execution.

        • continueAsNewWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNHANDLED_DECISION"
            • "WORKFLOW_TYPE_DEPRECATED"
            • "WORKFLOW_TYPE_DOES_NOT_EXIST"
            • "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_CHILD_POLICY_UNDEFINED"
            • "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecutionTerminatedEventAttributes — (map)

          If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The reason provided for the termination.

          • details — (String)

            The details provided for the termination.

          • childPolicy — required — (String)

            The policy used for the child workflow executions of this workflow execution.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • cause — (String)

            If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

            Possible values include:
            • "CHILD_POLICY_APPLIED"
            • "EVENT_LIMIT_EXCEEDED"
            • "OPERATOR_INITIATED"
        • workflowExecutionCancelRequestedEventAttributes — (map)

          If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • externalWorkflowExecution — (map)

            The external workflow execution for which the cancellation was requested.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • externalInitiatedEventId — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • cause — (String)

            If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

            Possible values include:
            • "CHILD_POLICY_APPLIED"
        • decisionTaskScheduledEventAttributes — (map)

          If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • taskList — required — (map)

            The name of the task list in which the decision task was scheduled.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • startToCloseTimeout — (String)

            The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        • decisionTaskStartedEventAttributes — (map)

          If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • identity — (String)

            Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • decisionTaskCompletedEventAttributes — (map)

          If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • executionContext — (String)

            User defined context for the workflow execution.

          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • decisionTaskTimedOutEventAttributes — (map)

          If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of timeout that expired before the decision task could be completed.

            Possible values include:
            • "START_TO_CLOSE"
          • scheduledEventId — required — (Integer)

            The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskScheduledEventAttributes — (map)

          If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityType — required — (map)

            The type of the activity task.

            • name — required — (String)

              The name of this activity.

              Note: The combination of activity type name and version must be unique within a domain.
            • version — required — (String)

              The version of this activity.

              Note: The combination of activity type name and version must be unique with in a domain.
          • activityId — required — (String)

            The unique ID of the activity task.

          • input — (String)

            The input provided to the activity task.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

          • scheduleToStartTimeout — (String)

            The maximum amount of time the activity task can wait to be assigned to a worker.

          • scheduleToCloseTimeout — (String)

            The maximum amount of time for this activity task.

          • startToCloseTimeout — (String)

            The maximum amount of time a worker may take to process the activity task.

          • taskList — required — (map)

            The task list in which the activity task has been scheduled.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

            Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • heartbeatTimeout — (String)

            The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

        • activityTaskStartedEventAttributes — (map)

          If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • identity — (String)

            Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskCompletedEventAttributes — (map)

          If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • result — (String)

            The results of the activity task.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskFailedEventAttributes — (map)

          If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • reason — (String)

            The reason provided for the failure.

          • details — (String)

            The details of the failure.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskTimedOutEventAttributes — (map)

          If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timeoutType — required — (String)

            The type of the timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
            • "SCHEDULE_TO_START"
            • "SCHEDULE_TO_CLOSE"
            • "HEARTBEAT"
          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • details — (String)

            Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

        • activityTaskCanceledEventAttributes — (map)

          If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • details — (String)

            Details of the cancellation.

          • scheduledEventId — required — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • latestCancelRequestedEventId — (Integer)

            If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • activityTaskCancelRequestedEventAttributes — (map)

          If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • activityId — required — (String)

            The unique ID of the task.

        • workflowExecutionSignaledEventAttributes — (map)

          If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • signalName — required — (String)

            The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

          • input — (String)

            The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

          • externalWorkflowExecution — (map)

            The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • externalInitiatedEventId — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

        • markerRecordedEventAttributes — (map)

          If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.

          • markerName — required — (String)

            The name of the marker.

          • details — (String)

            The details of the marker.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • recordMarkerFailedEventAttributes — (map)

          If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • markerName — required — (String)

            The marker's name.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerStartedEventAttributes — (map)

          If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that was started.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks.

          • startToFireTimeout — required — (String)

            The duration of time after which the timer fires.

            The duration is specified in seconds, an integer greater than or equal to 0.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerFiredEventAttributes — (map)

          If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that fired.

          • startedEventId — required — (Integer)

            The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerCanceledEventAttributes — (map)

          If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The unique ID of the timer that was canceled.

          • startedEventId — required — (Integer)

            The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startChildWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the child workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • control — (String)

            Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

          • input — (String)

            The inputs provided to the child workflow execution.

          • executionStartToCloseTimeout — (String)

            The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • taskList — required — (map)

            The name of the task list used for the decision tasks of the child workflow execution.

            • name — required — (String)

              The name of the task list.

          • taskPriority — (String)

            The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

            For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

          • childPolicy — required — (String)

            The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

            The supported child policies are:

            • TERMINATE – The child executions are terminated.

            • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

            • ABANDON – No action is taken. The child executions continue to run.

            Possible values include:
            • "TERMINATE"
            • "REQUEST_CANCEL"
            • "ABANDON"
          • taskStartToCloseTimeout — (String)

            The maximum duration allowed for the decision tasks for this workflow execution.

            The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          • tagList — (Array<String>)

            The list of tags to associated with the child workflow execution.

          • lambdaRole — (String)

            The IAM role to attach to the child workflow execution.

        • childWorkflowExecutionStartedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was started.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionCompletedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was completed.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • result — (String)

            The result of the child workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that failed.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • reason — (String)

            The reason for the failure (if provided).

          • details — (String)

            The details of the failure (if provided).

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionTimedOutEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that timed out.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • timeoutType — required — (String)

            The type of the timeout that caused the child workflow execution to time out.

            Possible values include:
            • "START_TO_CLOSE"
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionCanceledEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was canceled.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • details — (String)

            Details of the cancellation (if provided).

          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • childWorkflowExecutionTerminatedEventAttributes — (map)

          If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The child workflow execution that was terminated.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • workflowType — required — (map)

            The type of the child workflow execution.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • initiatedEventId — required — (Integer)

            The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • signalExternalWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution.

          • runId — (String)

            The runId of the external workflow execution to send the signal to.

          • signalName — required — (String)

            The name of the signal.

          • input — (String)

            The input provided to the signal.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent decision tasks.

        • externalWorkflowExecutionSignaledEventAttributes — (map)

          If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The external workflow execution that the signal was delivered to.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • signalExternalWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution that the signal was being delivered to.

          • runId — (String)

            The runId of the external workflow execution that the signal was being delivered to.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"
            • "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • initiatedEventId — required — (Integer)

            The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

        • externalWorkflowExecutionCancelRequestedEventAttributes — (map)

          If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowExecution — required — (map)

            The external workflow execution to which the cancellation request was delivered.

            • workflowId — required — (String)

              The user defined identifier associated with the workflow execution.

            • runId — required — (String)

              A system-generated unique identifier for the workflow execution.

          • initiatedEventId — required — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • requestCancelExternalWorkflowExecutionInitiatedEventAttributes — (map)

          If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow execution to be canceled.

          • runId — (String)

            The runId of the external workflow execution to be canceled.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • requestCancelExternalWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowId — required — (String)

            The workflowId of the external workflow to which the cancel request was to be delivered.

          • runId — (String)

            The runId of the external workflow execution.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"
            • "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • initiatedEventId — required — (Integer)

            The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

        • scheduleActivityTaskFailedEventAttributes — (map)

          If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityType — required — (map)

            The activity type provided in the ScheduleActivityTask decision that failed.

            • name — required — (String)

              The name of this activity.

              Note: The combination of activity type name and version must be unique within a domain.
            • version — required — (String)

              The version of this activity.

              Note: The combination of activity type name and version must be unique with in a domain.
          • activityId — required — (String)

            The activityId provided in the ScheduleActivityTask decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ACTIVITY_TYPE_DEPRECATED"
            • "ACTIVITY_TYPE_DOES_NOT_EXIST"
            • "ACTIVITY_ID_ALREADY_IN_USE"
            • "OPEN_ACTIVITIES_LIMIT_EXCEEDED"
            • "ACTIVITY_CREATION_RATE_EXCEEDED"
            • "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED"
            • "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • requestCancelActivityTaskFailedEventAttributes — (map)

          If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • activityId — required — (String)

            The activityId provided in the RequestCancelActivityTask decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ACTIVITY_ID_UNKNOWN"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startTimerFailedEventAttributes — (map)

          If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The timerId provided in the StartTimer decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "TIMER_ID_ALREADY_IN_USE"
            • "OPEN_TIMERS_LIMIT_EXCEEDED"
            • "TIMER_CREATION_RATE_EXCEEDED"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • cancelTimerFailedEventAttributes — (map)

          If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • timerId — required — (String)

            The timerId provided in the CancelTimer decision that failed.

          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "TIMER_ID_UNKNOWN"
            • "OPERATION_NOT_PERMITTED"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startChildWorkflowExecutionFailedEventAttributes — (map)

          If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

          • workflowType — required — (map)

            The workflow type provided in the StartChildWorkflowExecution Decision that failed.

            • name — required — (String)

              The name of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
            • version — required — (String)

              The version of the workflow type.

              Note: The combination of workflow type name and version must be unique with in a domain.
          • cause — required — (String)

            The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

            Note: When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "WORKFLOW_TYPE_DOES_NOT_EXIST"
            • "WORKFLOW_TYPE_DEPRECATED"
            • "OPEN_CHILDREN_LIMIT_EXCEEDED"
            • "OPEN_WORKFLOWS_LIMIT_EXCEEDED"
            • "CHILD_CREATION_RATE_EXCEEDED"
            • "WORKFLOW_ALREADY_RUNNING"
            • "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_TASK_LIST_UNDEFINED"
            • "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"
            • "DEFAULT_CHILD_POLICY_UNDEFINED"
            • "OPERATION_NOT_PERMITTED"
          • workflowId — required — (String)

            The workflowId of the child workflow execution.

          • initiatedEventId — required — (Integer)

            When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.

            When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

          • control — (String)

            The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.

        • lambdaFunctionScheduledEventAttributes — (map)

          Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

          • id — required — (String)

            The unique ID of the Lambda task.

          • name — required — (String)

            The name of the Lambda function.

          • control — (String)

            Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

          • input — (String)

            The input provided to the Lambda task.

          • startToCloseTimeout — (String)

            The maximum amount of time a worker can take to process the Lambda task.

          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • lambdaFunctionStartedEventAttributes — (map)

          Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • lambdaFunctionCompletedEventAttributes — (map)

          Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • result — (String)

            The results of the Lambda task.

        • lambdaFunctionFailedEventAttributes — (map)

          Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • reason — (String)

            The reason provided for the failure.

          • details — (String)

            The details of the failure.

        • lambdaFunctionTimedOutEventAttributes — (map)

          Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.

          • scheduledEventId — required — (Integer)

            The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • startedEventId — required — (Integer)

            The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • timeoutType — (String)

            The type of the timeout that caused this event.

            Possible values include:
            • "START_TO_CLOSE"
        • scheduleLambdaFunctionFailedEventAttributes — (map)

          Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

          • id — required — (String)

            The ID provided in the ScheduleLambdaFunction decision that failed.

          • name — required — (String)

            The name of the Lambda function.

          • cause — required — (String)

            The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
            Possible values include:
            • "ID_ALREADY_IN_USE"
            • "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"
            • "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"
            • "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
          • decisionTaskCompletedEventId — required — (Integer)

            The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

        • startLambdaFunctionFailedEventAttributes — (map)

          Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

          • scheduledEventId — (Integer)

            The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

          • cause — (String)

            The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

            Note: If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.
            Possible values include:
            • "ASSUME_ROLE_FAILED"
          • message — (String)

            A description that can help diagnose the cause of the fault.

      • nextPageToken — (String)

        If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

        The configured maximumPageSize determines how many results can be returned in a single call.

      • previousStartedEventId — (Integer)

        The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

Note: The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.
Note: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the recordActivityTaskHeartbeat operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  details: 'STRING_VALUE'
};
swf.recordActivityTaskHeartbeat(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 taskToken of the ActivityTask.

      taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    • details — (String)

      If specified, contains details about the progress of the task.

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:

      • cancelRequested — (Boolean)

        Set to true if cancellation of the task is requested.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

    • name: String constraint. The key is swf:name.

    • version: String constraint. The key is swf:version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the registerActivityType operation

var params = {
  domain: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE', /* required */
  defaultTaskHeartbeatTimeout: 'STRING_VALUE',
  defaultTaskList: {
    name: 'STRING_VALUE' /* required */
  },
  defaultTaskPriority: 'STRING_VALUE',
  defaultTaskScheduleToCloseTimeout: 'STRING_VALUE',
  defaultTaskScheduleToStartTimeout: 'STRING_VALUE',
  defaultTaskStartToCloseTimeout: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
swf.registerActivityType(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: {}) —
    • domain — (String)

      The name of the domain in which this activity is to be registered.

    • name — (String)

      The name of the activity type within the domain.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • version — (String)

      The version of the activity type.

      Note: The activity type consists of the name and version, the combination of which must be unique within the domain.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • description — (String)

      A textual description of the activity type.

    • defaultTaskStartToCloseTimeout — (String)

      If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskHeartbeatTimeout — (String)

      If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskList — (map)

      If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

      • name — required — (String)

        The name of the task list.

    • defaultTaskPriority — (String)

      The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

      For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

    • defaultTaskScheduleToStartTimeout — (String)

      If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultTaskScheduleToCloseTimeout — (String)

      If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

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.

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

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the registerDomain operation

var params = {
  name: 'STRING_VALUE', /* required */
  workflowExecutionRetentionPeriodInDays: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
swf.registerDomain(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)

      Name of the domain to register. The name must be unique in the region that the domain is registered in.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • description — (String)

      A text description of the domain.

    • workflowExecutionRetentionPeriodInDays — (String)

      The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

      If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

      The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

    • tags — (Array<map>)

      Tags to be added when registering a domain.

      Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

      • key — required — (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.

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

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

    • name: String constraint. The key is swf:name.

    • version: String constraint. The key is swf:version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the registerWorkflowType operation

var params = {
  domain: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE', /* required */
  defaultChildPolicy: TERMINATE | REQUEST_CANCEL | ABANDON,
  defaultExecutionStartToCloseTimeout: 'STRING_VALUE',
  defaultLambdaRole: 'STRING_VALUE',
  defaultTaskList: {
    name: 'STRING_VALUE' /* required */
  },
  defaultTaskPriority: 'STRING_VALUE',
  defaultTaskStartToCloseTimeout: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
swf.registerWorkflowType(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: {}) —
    • domain — (String)

      The name of the domain in which to register the workflow type.

    • name — (String)

      The name of the workflow type.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • version — (String)

      The version of the workflow type.

      Note: The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • description — (String)

      Textual description of the workflow type.

    • defaultTaskStartToCloseTimeout — (String)

      If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • defaultExecutionStartToCloseTimeout — (String)

      If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

      The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

    • defaultTaskList — (map)

      If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

      • name — required — (String)

        The name of the task list.

    • defaultTaskPriority — (String)

      The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

      For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    • defaultChildPolicy — (String)

      If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      Possible values include:
      • "TERMINATE"
      • "REQUEST_CANCEL"
      • "ABANDON"
    • defaultLambdaRole — (String)

      The default IAM role attached to this workflow type.

      Note: Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

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.

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

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

Note: If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
Note: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the requestCancelWorkflowExecution operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  runId: 'STRING_VALUE'
};
swf.requestCancelWorkflowExecution(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow execution to cancel.

    • workflowId — (String)

      The workflowId of the workflow execution to cancel.

    • runId — (String)

      The runId of the workflow execution to cancel.

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.

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

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the respondActivityTaskCanceled operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  details: 'STRING_VALUE'
};
swf.respondActivityTaskCanceled(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 taskToken of the ActivityTask.

      taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    • details — (String)

      Information about the cancellation.

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.

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

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the respondActivityTaskCompleted operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  result: 'STRING_VALUE'
};
swf.respondActivityTaskCompleted(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 taskToken of the ActivityTask.

      taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    • result — (String)

      The result of the activity task. It is a free form string that is implementation specific.

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.

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

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the respondActivityTaskFailed operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  details: 'STRING_VALUE',
  reason: 'STRING_VALUE'
};
swf.respondActivityTaskFailed(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 taskToken of the ActivityTask.

      taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    • reason — (String)

      Description of the error that may assist in diagnostics.

    • details — (String)

      Detailed information about 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.

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

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the respondDecisionTaskCompleted operation

var params = {
  taskToken: 'STRING_VALUE', /* required */
  decisions: [
    {
      decisionType: ScheduleActivityTask | RequestCancelActivityTask | CompleteWorkflowExecution | FailWorkflowExecution | CancelWorkflowExecution | ContinueAsNewWorkflowExecution | RecordMarker | StartTimer | CancelTimer | SignalExternalWorkflowExecution | RequestCancelExternalWorkflowExecution | StartChildWorkflowExecution | ScheduleLambdaFunction, /* required */
      cancelTimerDecisionAttributes: {
        timerId: 'STRING_VALUE' /* required */
      },
      cancelWorkflowExecutionDecisionAttributes: {
        details: 'STRING_VALUE'
      },
      completeWorkflowExecutionDecisionAttributes: {
        result: 'STRING_VALUE'
      },
      continueAsNewWorkflowExecutionDecisionAttributes: {
        childPolicy: TERMINATE | REQUEST_CANCEL | ABANDON,
        executionStartToCloseTimeout: 'STRING_VALUE',
        input: 'STRING_VALUE',
        lambdaRole: 'STRING_VALUE',
        tagList: [
          'STRING_VALUE',
          /* more items */
        ],
        taskList: {
          name: 'STRING_VALUE' /* required */
        },
        taskPriority: 'STRING_VALUE',
        taskStartToCloseTimeout: 'STRING_VALUE',
        workflowTypeVersion: 'STRING_VALUE'
      },
      failWorkflowExecutionDecisionAttributes: {
        details: 'STRING_VALUE',
        reason: 'STRING_VALUE'
      },
      recordMarkerDecisionAttributes: {
        markerName: 'STRING_VALUE', /* required */
        details: 'STRING_VALUE'
      },
      requestCancelActivityTaskDecisionAttributes: {
        activityId: 'STRING_VALUE' /* required */
      },
      requestCancelExternalWorkflowExecutionDecisionAttributes: {
        workflowId: 'STRING_VALUE', /* required */
        control: 'STRING_VALUE',
        runId: 'STRING_VALUE'
      },
      scheduleActivityTaskDecisionAttributes: {
        activityId: 'STRING_VALUE', /* required */
        activityType: { /* required */
          name: 'STRING_VALUE', /* required */
          version: 'STRING_VALUE' /* required */
        },
        control: 'STRING_VALUE',
        heartbeatTimeout: 'STRING_VALUE',
        input: 'STRING_VALUE',
        scheduleToCloseTimeout: 'STRING_VALUE',
        scheduleToStartTimeout: 'STRING_VALUE',
        startToCloseTimeout: 'STRING_VALUE',
        taskList: {
          name: 'STRING_VALUE' /* required */
        },
        taskPriority: 'STRING_VALUE'
      },
      scheduleLambdaFunctionDecisionAttributes: {
        id: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        control: 'STRING_VALUE',
        input: 'STRING_VALUE',
        startToCloseTimeout: 'STRING_VALUE'
      },
      signalExternalWorkflowExecutionDecisionAttributes: {
        signalName: 'STRING_VALUE', /* required */
        workflowId: 'STRING_VALUE', /* required */
        control: 'STRING_VALUE',
        input: 'STRING_VALUE',
        runId: 'STRING_VALUE'
      },
      startChildWorkflowExecutionDecisionAttributes: {
        workflowId: 'STRING_VALUE', /* required */
        workflowType: { /* required */
          name: 'STRING_VALUE', /* required */
          version: 'STRING_VALUE' /* required */
        },
        childPolicy: TERMINATE | REQUEST_CANCEL | ABANDON,
        control: 'STRING_VALUE',
        executionStartToCloseTimeout: 'STRING_VALUE',
        input: 'STRING_VALUE',
        lambdaRole: 'STRING_VALUE',
        tagList: [
          'STRING_VALUE',
          /* more items */
        ],
        taskList: {
          name: 'STRING_VALUE' /* required */
        },
        taskPriority: 'STRING_VALUE',
        taskStartToCloseTimeout: 'STRING_VALUE'
      },
      startTimerDecisionAttributes: {
        startToFireTimeout: 'STRING_VALUE', /* required */
        timerId: 'STRING_VALUE', /* required */
        control: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  executionContext: 'STRING_VALUE'
};
swf.respondDecisionTaskCompleted(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 taskToken from the DecisionTask.

      taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    • decisions — (Array<map>)

      The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

      • decisionType — required — (String)

        Specifies the type of the decision.

        Possible values include:
        • "ScheduleActivityTask"
        • "RequestCancelActivityTask"
        • "CompleteWorkflowExecution"
        • "FailWorkflowExecution"
        • "CancelWorkflowExecution"
        • "ContinueAsNewWorkflowExecution"
        • "RecordMarker"
        • "StartTimer"
        • "CancelTimer"
        • "SignalExternalWorkflowExecution"
        • "RequestCancelExternalWorkflowExecution"
        • "StartChildWorkflowExecution"
        • "ScheduleLambdaFunction"
      • scheduleActivityTaskDecisionAttributes — (map)

        Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.

        • activityType — required — (map)

          The type of the activity task to schedule.

          • name — required — (String)

            The name of this activity.

            Note: The combination of activity type name and version must be unique within a domain.
          • version — required — (String)

            The version of this activity.

            Note: The combination of activity type name and version must be unique with in a domain.
        • activityId — required — (String)

          The activityId of the activity task.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

        • control — (String)

          Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

        • input — (String)

          The input provided to the activity task.

        • scheduleToCloseTimeout — (String)

          The maximum duration for this activity task.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
        • taskList — (map)

          If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

          Note: A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

          • name — required — (String)

            The name of the task list.

        • taskPriority — (String)

          If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • scheduleToStartTimeout — (String)

          If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
        • startToCloseTimeout — (String)

          If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
        • heartbeatTimeout — (String)

          If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      • requestCancelActivityTaskDecisionAttributes — (map)

        Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.

        • activityId — required — (String)

          The activityId of the activity task to be canceled.

      • completeWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

        • result — (String)

          The result of the workflow execution. The form of the result is implementation defined.

      • failWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

        • reason — (String)

          A descriptive reason for the failure that may help in diagnostics.

        • details — (String)

          Details of the failure.

      • cancelWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

        • details — (String)

          Details of the cancellation.

      • continueAsNewWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

        • input — (String)

          The input provided to the new workflow execution.

        • executionStartToCloseTimeout — (String)

          If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
        • taskList — (map)

          The task list to use for the decisions of the new (continued) workflow execution.

          • name — required — (String)

            The name of the task list.

        • taskPriority — (String)

          The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • taskStartToCloseTimeout — (String)

          Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
        • childPolicy — (String)

          If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

          The supported child policies are:

          • TERMINATE – The child executions are terminated.

          • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

          • ABANDON – No action is taken. The child executions continue to run.

          Note: A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
          Possible values include:
          • "TERMINATE"
          • "REQUEST_CANCEL"
          • "ABANDON"
        • tagList — (Array<String>)

          The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

        • workflowTypeVersion — (String)

          The version of the workflow to start.

        • lambdaRole — (String)

          The IAM role to attach to the new (continued) execution.

      • recordMarkerDecisionAttributes — (map)

        Provides the details of the RecordMarker decision. It isn't set for other decision types.

        • markerName — required — (String)

          The name of the marker.

        • details — (String)

          The details of the marker.

      • startTimerDecisionAttributes — (map)

        Provides the details of the StartTimer decision. It isn't set for other decision types.

        • timerId — required — (String)

          The unique ID of the timer.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

        • control — (String)

          The data attached to the event that can be used by the decider in subsequent workflow tasks.

        • startToFireTimeout — required — (String)

          The duration to wait before firing the timer.

          The duration is specified in seconds, an integer greater than or equal to 0.

      • cancelTimerDecisionAttributes — (map)

        Provides the details of the CancelTimer decision. It isn't set for other decision types.

        • timerId — required — (String)

          The unique ID of the timer to cancel.

      • signalExternalWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

        • workflowId — required — (String)

          The workflowId of the workflow execution to be signaled.

        • runId — (String)

          The runId of the workflow execution to be signaled.

        • signalName — required — (String)

          The name of the signal.The target workflow execution uses the signal name and input to process the signal.

        • input — (String)

          The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

        • control — (String)

          The data attached to the event that can be used by the decider in subsequent decision tasks.

      • requestCancelExternalWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.

        • workflowId — required — (String)

          The workflowId of the external workflow execution to cancel.

        • runId — (String)

          The runId of the external workflow execution to cancel.

        • control — (String)

          The data attached to the event that can be used by the decider in subsequent workflow tasks.

      • startChildWorkflowExecutionDecisionAttributes — (map)

        Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

        • workflowType — required — (map)

          The type of the workflow execution to be started.

          • name — required — (String)

            The name of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
          • version — required — (String)

            The version of the workflow type.

            Note: The combination of workflow type name and version must be unique with in a domain.
        • workflowId — required — (String)

          The workflowId of the workflow execution.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

        • control — (String)

          The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

        • input — (String)

          The input to be provided to the workflow execution.

        • executionStartToCloseTimeout — (String)

          The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
        • taskList — (map)

          The name of the task list to be used for decision tasks of the child workflow execution.

          Note: A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

          • name — required — (String)

            The name of the task list.

        • taskPriority — (String)

          A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

        • taskStartToCloseTimeout — (String)

          Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

          The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

          Note: A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
        • childPolicy — (String)

          If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

          The supported child policies are:

          • TERMINATE – The child executions are terminated.

          • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

          • ABANDON – No action is taken. The child executions continue to run.

          Note: A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
          Possible values include:
          • "TERMINATE"
          • "REQUEST_CANCEL"
          • "ABANDON"
        • tagList — (Array<String>)

          The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

        • lambdaRole — (String)

          The IAM role attached to the child workflow execution.

      • scheduleLambdaFunctionDecisionAttributes — (map)

        Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.

        • id — required — (String)

          A string that identifies the Lambda function execution in the event history.

        • name — required — (String)

          The name, or ARN, of the Lambda function to schedule.

        • control — (String)

          The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

        • input — (String)

          The optional input data to be supplied to the Lambda function.

        • startToCloseTimeout — (String)

          The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.

    • executionContext — (String)

      User defined context to add to workflow execution.

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.

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

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

Note: If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.
Note: If the specified workflow execution isn't open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the signalWorkflowExecution operation

var params = {
  domain: 'STRING_VALUE', /* required */
  signalName: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  input: 'STRING_VALUE',
  runId: 'STRING_VALUE'
};
swf.signalWorkflowExecution(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: {}) —
    • domain — (String)

      The name of the domain containing the workflow execution to signal.

    • workflowId — (String)

      The workflowId of the workflow execution to signal.

    • runId — (String)

      The runId of the workflow execution to signal.

    • signalName — (String)

      The name of the signal. This name must be meaningful to the target workflow.

    • input — (String)

      Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tagList.member.0: The key is swf:tagList.member.0.

    • tagList.member.1: The key is swf:tagList.member.1.

    • tagList.member.2: The key is swf:tagList.member.2.

    • tagList.member.3: The key is swf:tagList.member.3.

    • tagList.member.4: The key is swf:tagList.member.4.

    • taskList: String constraint. The key is swf:taskList.name.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the startWorkflowExecution operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  workflowType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  childPolicy: TERMINATE | REQUEST_CANCEL | ABANDON,
  executionStartToCloseTimeout: 'STRING_VALUE',
  input: 'STRING_VALUE',
  lambdaRole: 'STRING_VALUE',
  tagList: [
    'STRING_VALUE',
    /* more items */
  ],
  taskList: {
    name: 'STRING_VALUE' /* required */
  },
  taskPriority: 'STRING_VALUE',
  taskStartToCloseTimeout: 'STRING_VALUE'
};
swf.startWorkflowExecution(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: {}) —
    • domain — (String)

      The name of the domain in which the workflow execution is created.

    • workflowId — (String)

      The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    • workflowType — (map)

      The type of the workflow to start.

      • name — required — (String)

        The name of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.
      • version — required — (String)

        The version of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.
    • taskList — (map)

      The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

      Note: A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

      The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

      • name — required — (String)

        The name of the task list.

    • taskPriority — (String)

      The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

      For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    • input — (String)

      The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

    • executionStartToCloseTimeout — (String)

      The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

      The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

      Note: An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
    • tagList — (Array<String>)

      The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

    • taskStartToCloseTimeout — (String)

      Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      Note: A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
    • childPolicy — (String)

      If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      Note: A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
      Possible values include:
      • "TERMINATE"
      • "REQUEST_CANCEL"
      • "ABANDON"
    • lambdaRole — (String)

      The IAM role to attach to this workflow execution.

      Note: Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

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:

      • runId — (String)

        The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Add a tag to a Amazon SWF domain.

Note: Amazon SWF supports a maximum of 50 tags per resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
swf.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 Amazon SWF domain.

    • tags — (Array<map>)

      The list of tags to add to a domain.

      Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

      • key — required — (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.

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

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately.

Note: If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.
Note: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the terminateWorkflowExecution operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowId: 'STRING_VALUE', /* required */
  childPolicy: TERMINATE | REQUEST_CANCEL | ABANDON,
  details: 'STRING_VALUE',
  reason: 'STRING_VALUE',
  runId: 'STRING_VALUE'
};
swf.terminateWorkflowExecution(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: {}) —
    • domain — (String)

      The domain of the workflow execution to terminate.

    • workflowId — (String)

      The workflowId of the workflow execution to terminate.

    • runId — (String)

      The runId of the workflow execution to terminate.

    • reason — (String)

      A descriptive reason for terminating the workflow execution.

    • details — (String)

      Details for terminating the workflow execution.

    • childPolicy — (String)

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      Note: A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
      Possible values include:
      • "TERMINATE"
      • "REQUEST_CANCEL"
      • "ABANDON"

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.

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

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • activityType.name: String constraint. The key is swf:activityType.name.

    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the undeprecateActivityType operation

var params = {
  activityType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  domain: 'STRING_VALUE' /* required */
};
swf.undeprecateActivityType(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: {}) —
    • domain — (String)

      The name of the domain of the deprecated activity type.

    • activityType — (map)

      The activity type to undeprecate.

      • name — required — (String)

        The name of this activity.

        Note: The combination of activity type name and version must be unique within a domain.
      • version — required — (String)

        The version of this activity.

        Note: The combination of activity type name and version must be unique with in a domain.

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.

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

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the undeprecateDomain operation

var params = {
  name: 'STRING_VALUE' /* required */
};
swf.undeprecateDomain(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 domain of the deprecated workflow type.

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.

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

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Service Reference:

Examples:

Calling the undeprecateWorkflowType operation

var params = {
  domain: 'STRING_VALUE', /* required */
  workflowType: { /* required */
    name: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  }
};
swf.undeprecateWorkflowType(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: {}) —
    • domain — (String)

      The name of the domain of the deprecated workflow type.

    • workflowType — (map)

      The name of the domain of the deprecated workflow type.

      • name — required — (String)

        The name of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.
      • version — required — (String)

        The version of the workflow type.

        Note: The combination of workflow type name and version must be unique with in a domain.

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.

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

Remove a tag from a Amazon SWF domain.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
swf.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 Amazon SWF domain.

    • tagKeys — (Array<String>)

      The list of tags to remove from the Amazon SWF domain.

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.