universal-s3

import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config'; interface Blob {} declare class StepFunctions extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: StepFunctions.Types.ClientConfiguration) config: Config & StepFunctions.Types.ClientConfiguration; /** * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different. */ createActivity(params: StepFunctions.Types.CreateActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>; /** * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different. */ createActivity(callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>; /** * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different. */ createStateMachine(params: StepFunctions.Types.CreateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>; /** * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different. */ createStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>; /** * Deletes an activity. */ deleteActivity(params: StepFunctions.Types.DeleteActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>; /** * Deletes an activity. */ deleteActivity(callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>; /** * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted. */ deleteStateMachine(params: StepFunctions.Types.DeleteStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>; /** * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted. */ deleteStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>; /** * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeActivity(params: StepFunctions.Types.DescribeActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>; /** * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeActivity(callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>; /** * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeExecution(params: StepFunctions.Types.DescribeExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>; /** * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>; /** * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeStateMachine(params: StepFunctions.Types.DescribeStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>; /** * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>; /** * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeStateMachineForExecution(params: StepFunctions.Types.DescribeStateMachineForExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>; /** * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeStateMachineForExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>; /** * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. */ getActivityTask(params: StepFunctions.Types.GetActivityTaskInput, callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>; /** * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. */ getActivityTask(callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>; /** * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ getExecutionHistory(params: StepFunctions.Types.GetExecutionHistoryInput, callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>; /** * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ getExecutionHistory(callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>; /** * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listActivities(params: StepFunctions.Types.ListActivitiesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>; /** * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listActivities(callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>; /** * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listExecutions(params: StepFunctions.Types.ListExecutionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>; /** * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listExecutions(callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>; /** * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listStateMachines(params: StepFunctions.Types.ListStateMachinesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>; /** * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listStateMachines(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>; /** * List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ listTagsForResource(params: StepFunctions.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>; /** * List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ listTagsForResource(callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed. */ sendTaskFailure(params: StepFunctions.Types.SendTaskFailureInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed. */ sendTaskFailure(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats. */ sendTaskHeartbeat(params: StepFunctions.Types.SendTaskHeartbeatInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats. */ sendTaskHeartbeat(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully. */ sendTaskSuccess(params: StepFunctions.Types.SendTaskSuccessInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully. */ sendTaskSuccess(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>; /** * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. */ startExecution(params: StepFunctions.Types.StartExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>; /** * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. */ startExecution(callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>; /** * Stops an execution. */ stopExecution(params: StepFunctions.Types.StopExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>; /** * Stops an execution. */ stopExecution(callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>; /** * Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ tagResource(params: StepFunctions.Types.TagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>; /** * Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ tagResource(callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>; /** * Remove a tag from a Step Functions resource */ untagResource(params: StepFunctions.Types.UntagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>; /** * Remove a tag from a Step Functions resource */ untagResource(callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>; /** * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. */ updateStateMachine(params: StepFunctions.Types.UpdateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>; /** * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. */ updateStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>; } declare namespace StepFunctions { export interface ActivityFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export type ActivityList = ActivityListItem[]; export interface ActivityListItem { /** * The Amazon Resource Name (ARN) that identifies the activity. */ activityArn: Arn; /** * The name of the activity. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The date the activity is created. */ creationDate: Timestamp; } export interface ActivityScheduleFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export interface ActivityScheduledEventDetails { /** * The Amazon Resource Name (ARN) of the scheduled activity. */ resource: Arn; /** * The JSON data input to the activity task. */ input?: SensitiveData; /** * The maximum allowed duration of the activity task. */ timeoutInSeconds?: TimeoutInSeconds; /** * The maximum allowed duration between two heartbeats for the activity task. */ heartbeatInSeconds?: TimeoutInSeconds; } export interface ActivityStartedEventDetails { /** * The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask. */ workerName?: Identity; } export interface ActivitySucceededEventDetails { /** * The JSON data output by the activity task. */ output?: SensitiveData; } export interface ActivityTimedOutEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the timeout. */ cause?: SensitiveCause; } export type Arn = string; export type ConnectorParameters = string; export interface CreateActivityInput { /** * The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The list of tags to add to a resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ tags?: TagList; } export interface CreateActivityOutput { /** * The Amazon Resource Name (ARN) that identifies the created activity. */ activityArn: Arn; /** * The date the activity is created. */ creationDate: Timestamp; } export interface CreateStateMachineInput { /** * The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The Amazon States Language definition of the state machine. See Amazon States Language. */ definition: Definition; /** * The Amazon Resource Name (ARN) of the IAM role to use for this state machine. */ roleArn: Arn; /** * Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ tags?: TagList; } export interface CreateStateMachineOutput { /** * The Amazon Resource Name (ARN) that identifies the created state machine. */ stateMachineArn: Arn; /** * The date the state machine is created. */ creationDate: Timestamp; } export type Definition = string; export interface DeleteActivityInput { /** * The Amazon Resource Name (ARN) of the activity to delete. */ activityArn: Arn; } export interface DeleteActivityOutput { } export interface DeleteStateMachineInput { /** * The Amazon Resource Name (ARN) of the state machine to delete. */ stateMachineArn: Arn; } export interface DeleteStateMachineOutput { } export interface DescribeActivityInput { /** * The Amazon Resource Name (ARN) of the activity to describe. */ activityArn: Arn; } export interface DescribeActivityOutput { /** * The Amazon Resource Name (ARN) that identifies the activity. */ activityArn: Arn; /** * The name of the activity. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The date the activity is created. */ creationDate: Timestamp; } export interface DescribeExecutionInput { /** * The Amazon Resource Name (ARN) of the execution to describe. */ executionArn: Arn; } export interface DescribeExecutionOutput { /** * The Amazon Resource Name (ARN) that identifies the execution. */ executionArn: Arn; /** * The Amazon Resource Name (ARN) of the executed stated machine. */ stateMachineArn: Arn; /** * The name of the execution. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name?: Name; /** * The current status of the execution. */ status: ExecutionStatus; /** * The date the execution is started. */ startDate: Timestamp; /** * If the execution has already ended, the date the execution stopped. */ stopDate?: Timestamp; /** * The string that contains the JSON input data of the execution. */ input: SensitiveData; /** * The JSON output data of the execution. This field is set only if the execution succeeds. If the execution fails, this field is null. */ output?: SensitiveData; } export interface DescribeStateMachineForExecutionInput { /** * The Amazon Resource Name (ARN) of the execution you want state machine information for. */ executionArn: Arn; } export interface DescribeStateMachineForExecutionOutput { /** * The Amazon Resource Name (ARN) of the state machine associated with the execution. */ stateMachineArn: Arn; /** * The name of the state machine associated with the execution. */ name: Name; /** * The Amazon States Language definition of the state machine. See Amazon States Language. */ definition: Definition; /** * The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. */ roleArn: Arn; /** * The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date. */ updateDate: Timestamp; } export interface DescribeStateMachineInput { /** * The Amazon Resource Name (ARN) of the state machine to describe. */ stateMachineArn: Arn; } export interface DescribeStateMachineOutput { /** * The Amazon Resource Name (ARN) that identifies the state machine. */ stateMachineArn: Arn; /** * The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The current status of the state machine. */ status?: StateMachineStatus; /** * The Amazon States Language definition of the state machine. See Amazon States Language. */ definition: Definition; /** * The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.) */ roleArn: Arn; /** * The date the state machine is created. */ creationDate: Timestamp; } export type EventId = number; export interface ExecutionAbortedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export interface ExecutionFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export type ExecutionList = ExecutionListItem[]; export interface ExecutionListItem { /** * The Amazon Resource Name (ARN) that identifies the execution. */ executionArn: Arn; /** * The Amazon Resource Name (ARN) of the executed state machine. */ stateMachineArn: Arn; /** * The name of the execution. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) */ name: Name; /** * The current status of the execution. */ status: ExecutionStatus; /** * The date the execution started. */ startDate: Timestamp; /** * If the execution already ended, the date the execution stopped. */ stopDate?: Timestamp; } export interface ExecutionStartedEventDetails { /** * The JSON data input to the execution. */ input?: SensitiveData; /** * The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks. */ roleArn?: Arn; } export type ExecutionStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|string; export interface ExecutionSucceededEventDetails { /** * The JSON data output by the execution. */ output?: SensitiveData; } export interface ExecutionTimedOutEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the timeout. */ cause?: SensitiveCause; } export interface GetActivityTaskInput { /** * The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.) */ activityArn: Arn; /** * You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history. */ workerName?: Name; } export interface GetActivityTaskOutput { /** * A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task. */ taskToken?: TaskToken; /** * The string that contains the JSON input data for the task. */ input?: SensitiveDataJobInput; } export interface GetExecutionHistoryInput { /** * The Amazon Resource Name (ARN) of the execution. */ executionArn: Arn; /** * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. */ maxResults?: PageSize; /** * Lists events in descending order of their timeStamp. */ reverseOrder?: ReverseOrder; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: PageToken; } export interface GetExecutionHistoryOutput { /** * The list of events that occurred in the execution. */ events: HistoryEventList; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: PageToken; } export interface HistoryEvent { /** * The date and time the event occurred. */ timestamp: Timestamp; /** * The type of the event. */ type: HistoryEventType; /** * The id of the event. Events are numbered sequentially, starting at one. */ id: EventId; /** * The id of the previous event. */ previousEventId?: EventId; activityFailedEventDetails?: ActivityFailedEventDetails; /** * Contains details about an activity schedule event that failed during an execution. */ activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails; activityScheduledEventDetails?: ActivityScheduledEventDetails; activityStartedEventDetails?: ActivityStartedEventDetails; activitySucceededEventDetails?: ActivitySucceededEventDetails; activityTimedOutEventDetails?: ActivityTimedOutEventDetails; /** * Contains details about the failure of a task. */ taskFailedEventDetails?: TaskFailedEventDetails; /** * Contains details about a task that was scheduled. */ taskScheduledEventDetails?: TaskScheduledEventDetails; /** * Contains details about a task that failed to start. */ taskStartFailedEventDetails?: TaskStartFailedEventDetails; /** * Contains details about a task that was started. */ taskStartedEventDetails?: TaskStartedEventDetails; /** * Contains details about a task that where the submit failed. */ taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails; /** * Contains details about a submitted task. */ taskSubmittedEventDetails?: TaskSubmittedEventDetails; /** * Contains details about a task that succeeded. */ taskSucceededEventDetails?: TaskSucceededEventDetails; /** * Contains details about a task that timed out. */ taskTimedOutEventDetails?: TaskTimedOutEventDetails; executionFailedEventDetails?: ExecutionFailedEventDetails; executionStartedEventDetails?: ExecutionStartedEventDetails; executionSucceededEventDetails?: ExecutionSucceededEventDetails; executionAbortedEventDetails?: ExecutionAbortedEventDetails; executionTimedOutEventDetails?: ExecutionTimedOutEventDetails; /** * Contains details about Map state that was started. */ mapStateStartedEventDetails?: MapStateStartedEventDetails; /** * Contains details about an iteration of a Map state that was started. */ mapIterationStartedEventDetails?: MapIterationEventDetails; /** * Contains details about an iteration of a Map state that succeeded. */ mapIterationSucceededEventDetails?: MapIterationEventDetails; /** * Contains details about an iteration of a Map state that failed. */ mapIterationFailedEventDetails?: MapIterationEventDetails; /** * Contains details about an iteration of a Map state that was aborted. */ mapIterationAbortedEventDetails?: MapIterationEventDetails; lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails; lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails; lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails; /** * Contains details about a lambda function that failed to start during an execution. */ lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails; /** * Contains details about a lambda function that terminated successfully during an execution. */ lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails; lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails; stateEnteredEventDetails?: StateEnteredEventDetails; stateExitedEventDetails?: StateExitedEventDetails; } export type HistoryEventList = HistoryEvent[]; export type HistoryEventType = "ActivityFailed"|"ActivityScheduled"|"ActivityScheduleFailed"|"ActivityStarted"|"ActivitySucceeded"|"ActivityTimedOut"|"ChoiceStateEntered"|"ChoiceStateExited"|"ExecutionAborted"|"ExecutionFailed"|"ExecutionStarted"|"ExecutionSucceeded"|"ExecutionTimedOut"|"FailStateEntered"|"LambdaFunctionFailed"|"LambdaFunctionScheduled"|"LambdaFunctionScheduleFailed"|"LambdaFunctionStarted"|"LambdaFunctionStartFailed"|"LambdaFunctionSucceeded"|"LambdaFunctionTimedOut"|"MapIterationAborted"|"MapIterationFailed"|"MapIterationStarted"|"MapIterationSucceeded"|"MapStateAborted"|"MapStateEntered"|"MapStateExited"|"MapStateFailed"|"MapStateStarted"|"MapStateSucceeded"|"ParallelStateAborted"|"ParallelStateEntered"|"ParallelStateExited"|"ParallelStateFailed"|"ParallelStateStarted"|"ParallelStateSucceeded"|"PassStateEntered"|"PassStateExited"|"SucceedStateEntered"|"SucceedStateExited"|"TaskFailed"|"TaskScheduled"|"TaskStarted"|"TaskStartFailed"|"TaskStateAborted"|"TaskStateEntered"|"TaskStateExited"|"TaskSubmitFailed"|"TaskSubmitted"|"TaskSucceeded"|"TaskTimedOut"|"WaitStateAborted"|"WaitStateEntered"|"WaitStateExited"|string; export type Identity = string; export interface LambdaFunctionFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export interface LambdaFunctionScheduleFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export interface LambdaFunctionScheduledEventDetails { /** * The Amazon Resource Name (ARN) of the scheduled lambda function. */ resource: Arn; /** * The JSON data input to the lambda function. */ input?: SensitiveData; /** * The maximum allowed duration of the lambda function. */ timeoutInSeconds?: TimeoutInSeconds; } export interface LambdaFunctionStartFailedEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the failure. */ cause?: SensitiveCause; } export interface LambdaFunctionSucceededEventDetails { /** * The JSON data output by the lambda function. */ output?: SensitiveData; } export interface LambdaFunctionTimedOutEventDetails { /** * The error code of the failure. */ error?: SensitiveError; /** * A more detailed explanation of the cause of the timeout. */ cause?: SensitiveCause; } export interface ListActivitiesInput { /** * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. */ maxResults?: PageSize; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: PageToken; } export interface ListActivitiesOutput { /** * The list of activities. */ activities: ActivityList; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: PageToken; } export interface ListExecutionsInput { /** * The Amazon Resource Name (ARN) of the state machine whose executions is listed. */ stateMachineArn: Arn; /** * If specified, only list the executions whose current execution status matches the given filter. */ statusFilter?: ExecutionStatus; /** * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. */ maxResults?: PageSize; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: ListExecutionsPageToken; } export interface ListExecutionsOutput { /** * The list of matching executions. */ executions: ExecutionList; /** * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. */ nextToken?: ListExecutionsPageToken; } export type ListExecutionsPageToken = string; export interface ListStateMachinesInput { /** * The maximum number of results that are returned per call.