Documentation ¶
Overview ¶
Package sfn provides the client and types for making API requests to AWS SFN.
AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide (https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) .
See https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23 for more information on this service.
See sfn package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sfn/
Using the Client ¶
To use AWS SFN with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS SFN client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sfn/#New
Index ¶
- Constants
- type ActivityFailedEventDetails
- type ActivityListItem
- type ActivityScheduleFailedEventDetails
- type ActivityScheduledEventDetails
- type ActivityStartedEventDetails
- type ActivitySucceededEventDetails
- type ActivityTimedOutEventDetails
- type Client
- func (c *Client) CreateActivityRequest(input *CreateActivityInput) CreateActivityRequest
- func (c *Client) CreateStateMachineRequest(input *CreateStateMachineInput) CreateStateMachineRequest
- func (c *Client) DeleteActivityRequest(input *DeleteActivityInput) DeleteActivityRequest
- func (c *Client) DeleteStateMachineRequest(input *DeleteStateMachineInput) DeleteStateMachineRequest
- func (c *Client) DescribeActivityRequest(input *DescribeActivityInput) DescribeActivityRequest
- func (c *Client) DescribeExecutionRequest(input *DescribeExecutionInput) DescribeExecutionRequest
- func (c *Client) DescribeStateMachineForExecutionRequest(input *DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest
- func (c *Client) DescribeStateMachineRequest(input *DescribeStateMachineInput) DescribeStateMachineRequest
- func (c *Client) GetActivityTaskRequest(input *GetActivityTaskInput) GetActivityTaskRequest
- func (c *Client) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) GetExecutionHistoryRequest
- func (c *Client) ListActivitiesRequest(input *ListActivitiesInput) ListActivitiesRequest
- func (c *Client) ListExecutionsRequest(input *ListExecutionsInput) ListExecutionsRequest
- func (c *Client) ListStateMachinesRequest(input *ListStateMachinesInput) ListStateMachinesRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) SendTaskFailureRequest(input *SendTaskFailureInput) SendTaskFailureRequest
- func (c *Client) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) SendTaskHeartbeatRequest
- func (c *Client) SendTaskSuccessRequest(input *SendTaskSuccessInput) SendTaskSuccessRequest
- func (c *Client) StartExecutionRequest(input *StartExecutionInput) StartExecutionRequest
- func (c *Client) StopExecutionRequest(input *StopExecutionInput) StopExecutionRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateStateMachineRequest(input *UpdateStateMachineInput) UpdateStateMachineRequest
- type CreateActivityInput
- type CreateActivityOutput
- type CreateActivityRequest
- type CreateActivityResponse
- type CreateStateMachineInput
- type CreateStateMachineOutput
- type CreateStateMachineRequest
- type CreateStateMachineResponse
- type DeleteActivityInput
- type DeleteActivityOutput
- type DeleteActivityRequest
- type DeleteActivityResponse
- type DeleteStateMachineInput
- type DeleteStateMachineOutput
- type DeleteStateMachineRequest
- type DeleteStateMachineResponse
- type DescribeActivityInput
- type DescribeActivityOutput
- type DescribeActivityRequest
- type DescribeActivityResponse
- type DescribeExecutionInput
- type DescribeExecutionOutput
- type DescribeExecutionRequest
- type DescribeExecutionResponse
- type DescribeStateMachineForExecutionInput
- type DescribeStateMachineForExecutionOutput
- type DescribeStateMachineForExecutionRequest
- type DescribeStateMachineForExecutionResponse
- type DescribeStateMachineInput
- type DescribeStateMachineOutput
- type DescribeStateMachineRequest
- type DescribeStateMachineResponse
- type ExecutionAbortedEventDetails
- type ExecutionFailedEventDetails
- type ExecutionListItem
- type ExecutionStartedEventDetails
- type ExecutionStatus
- type ExecutionSucceededEventDetails
- type ExecutionTimedOutEventDetails
- type GetActivityTaskInput
- type GetActivityTaskOutput
- type GetActivityTaskRequest
- type GetActivityTaskResponse
- type GetExecutionHistoryInput
- type GetExecutionHistoryOutput
- type GetExecutionHistoryPaginator
- type GetExecutionHistoryRequest
- type GetExecutionHistoryResponse
- type HistoryEvent
- type HistoryEventType
- type LambdaFunctionFailedEventDetails
- type LambdaFunctionScheduleFailedEventDetails
- type LambdaFunctionScheduledEventDetails
- type LambdaFunctionStartFailedEventDetails
- type LambdaFunctionSucceededEventDetails
- type LambdaFunctionTimedOutEventDetails
- type ListActivitiesInput
- type ListActivitiesOutput
- type ListActivitiesPaginator
- type ListActivitiesRequest
- type ListActivitiesResponse
- type ListExecutionsInput
- type ListExecutionsOutput
- type ListExecutionsPaginator
- type ListExecutionsRequest
- type ListExecutionsResponse
- type ListStateMachinesInput
- type ListStateMachinesOutput
- type ListStateMachinesPaginator
- type ListStateMachinesRequest
- type ListStateMachinesResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type MapIterationEventDetails
- type MapStateStartedEventDetails
- type SendTaskFailureInput
- type SendTaskFailureOutput
- type SendTaskFailureRequest
- type SendTaskFailureResponse
- type SendTaskHeartbeatInput
- type SendTaskHeartbeatOutput
- type SendTaskHeartbeatRequest
- type SendTaskHeartbeatResponse
- type SendTaskSuccessInput
- type SendTaskSuccessOutput
- type SendTaskSuccessRequest
- type SendTaskSuccessResponse
- type StartExecutionInput
- type StartExecutionOutput
- type StartExecutionRequest
- type StartExecutionResponse
- type StateEnteredEventDetails
- type StateExitedEventDetails
- type StateMachineListItem
- type StateMachineStatus
- type StopExecutionInput
- type StopExecutionOutput
- type StopExecutionRequest
- type StopExecutionResponse
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type TaskFailedEventDetails
- type TaskScheduledEventDetails
- type TaskStartFailedEventDetails
- type TaskStartedEventDetails
- type TaskSubmitFailedEventDetails
- type TaskSubmittedEventDetails
- type TaskSucceededEventDetails
- type TaskTimedOutEventDetails
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateStateMachineInput
- type UpdateStateMachineOutput
- type UpdateStateMachineRequest
- type UpdateStateMachineResponse
Constants ¶
const ( ServiceName = "AWS SFN" // Service's name ServiceID = "SFN" // Service's identifier EndpointsID = "states" // Service's Endpoint identifier )
const ( // ErrCodeActivityDoesNotExist for service response error code // "ActivityDoesNotExist". // // The specified activity does not exist. ErrCodeActivityDoesNotExist = "ActivityDoesNotExist" // ErrCodeActivityLimitExceeded for service response error code // "ActivityLimitExceeded". // // The maximum number of activities has been reached. Existing activities must // be deleted before a new activity can be created. ErrCodeActivityLimitExceeded = "ActivityLimitExceeded" // ErrCodeActivityWorkerLimitExceeded for service response error code // "ActivityWorkerLimitExceeded". // // The maximum number of workers concurrently polling for activity tasks has // been reached. ErrCodeActivityWorkerLimitExceeded = "ActivityWorkerLimitExceeded" // ErrCodeExecutionAlreadyExists for service response error code // "ExecutionAlreadyExists". // // The execution has the same name as another execution (but a different input). // // Executions with the same name and input are considered idempotent. ErrCodeExecutionAlreadyExists = "ExecutionAlreadyExists" // ErrCodeExecutionDoesNotExist for service response error code // "ExecutionDoesNotExist". // // The specified execution does not exist. ErrCodeExecutionDoesNotExist = "ExecutionDoesNotExist" // ErrCodeExecutionLimitExceeded for service response error code // "ExecutionLimitExceeded". // // The maximum number of running executions has been reached. Running executions // must end or be stopped before a new execution can be started. ErrCodeExecutionLimitExceeded = "ExecutionLimitExceeded" // ErrCodeInvalidArn for service response error code // "InvalidArn". // // The provided Amazon Resource Name (ARN) is invalid. ErrCodeInvalidArn = "InvalidArn" // ErrCodeInvalidDefinition for service response error code // "InvalidDefinition". // // The provided Amazon States Language definition is invalid. ErrCodeInvalidDefinition = "InvalidDefinition" // ErrCodeInvalidExecutionInput for service response error code // "InvalidExecutionInput". // // The provided JSON input data is invalid. ErrCodeInvalidExecutionInput = "InvalidExecutionInput" // ErrCodeInvalidName for service response error code // "InvalidName". // // The provided name is invalid. ErrCodeInvalidName = "InvalidName" // ErrCodeInvalidOutput for service response error code // "InvalidOutput". // // The provided JSON output data is invalid. ErrCodeInvalidOutput = "InvalidOutput" // ErrCodeInvalidToken for service response error code // "InvalidToken". // // The provided token is invalid. ErrCodeInvalidToken = "InvalidToken" // ErrCodeMissingRequiredParameter for service response error code // "MissingRequiredParameter". // // Request is missing a required parameter. This error occurs if both definition // and roleArn are not specified. ErrCodeMissingRequiredParameter = "MissingRequiredParameter" // ErrCodeResourceNotFound for service response error code // "ResourceNotFound". // // Could not find the referenced resource. Only state machine and activity ARNs // are supported. ErrCodeResourceNotFound = "ResourceNotFound" // ErrCodeStateMachineAlreadyExists for service response error code // "StateMachineAlreadyExists". // // A state machine with the same name but a different definition or role ARN // already exists. ErrCodeStateMachineAlreadyExists = "StateMachineAlreadyExists" // ErrCodeStateMachineDeleting for service response error code // "StateMachineDeleting". // // The specified state machine is being deleted. ErrCodeStateMachineDeleting = "StateMachineDeleting" // ErrCodeStateMachineDoesNotExist for service response error code // "StateMachineDoesNotExist". // // The specified state machine does not exist. ErrCodeStateMachineDoesNotExist = "StateMachineDoesNotExist" // ErrCodeStateMachineLimitExceeded for service response error code // "StateMachineLimitExceeded". // // The maximum number of state machines has been reached. Existing state machines // must be deleted before a new state machine can be created. ErrCodeStateMachineLimitExceeded = "StateMachineLimitExceeded" // ErrCodeTaskDoesNotExist for service response error code // "TaskDoesNotExist". ErrCodeTaskDoesNotExist = "TaskDoesNotExist" // ErrCodeTaskTimedOut for service response error code // "TaskTimedOut". ErrCodeTaskTimedOut = "TaskTimedOut" // ErrCodeTooManyTags for service response error code // "TooManyTags". // // You've exceeded the number of tags allowed for a resource. See the Limits // Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) // in the AWS Step Functions Developer Guide. ErrCodeTooManyTags = "TooManyTags" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivityFailedEventDetails ¶
type ActivityFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity that failed during an execution.
func (ActivityFailedEventDetails) String ¶
func (s ActivityFailedEventDetails) String() string
String returns the string representation
type ActivityListItem ¶
type ActivityListItem struct { // The Amazon Resource Name (ARN) that identifies the activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about an activity.
func (ActivityListItem) String ¶
func (s ActivityListItem) String() string
String returns the string representation
type ActivityScheduleFailedEventDetails ¶
type ActivityScheduleFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity schedule failure that occurred during an execution.
func (ActivityScheduleFailedEventDetails) String ¶
func (s ActivityScheduleFailedEventDetails) String() string
String returns the string representation
type ActivityScheduledEventDetails ¶
type ActivityScheduledEventDetails struct { // The maximum allowed duration between two heartbeats for the activity task. HeartbeatInSeconds *int64 `locationName:"heartbeatInSeconds" type:"long"` // The JSON data input to the activity task. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the scheduled activity. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The maximum allowed duration of the activity task. TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` // contains filtered or unexported fields }
Contains details about an activity scheduled during an execution.
func (ActivityScheduledEventDetails) String ¶
func (s ActivityScheduledEventDetails) String() string
String returns the string representation
type ActivityStartedEventDetails ¶
type ActivityStartedEventDetails struct { // The name of the worker that the task is assigned to. These names are provided // by the workers when calling GetActivityTask. WorkerName *string `locationName:"workerName" type:"string"` // contains filtered or unexported fields }
Contains details about the start of an activity during an execution.
func (ActivityStartedEventDetails) String ¶
func (s ActivityStartedEventDetails) String() string
String returns the string representation
type ActivitySucceededEventDetails ¶
type ActivitySucceededEventDetails struct { // The JSON data output by the activity task. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about an activity that successfully terminated during an execution.
func (ActivitySucceededEventDetails) String ¶
func (s ActivitySucceededEventDetails) String() string
String returns the string representation
type ActivityTimedOutEventDetails ¶
type ActivityTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity timeout that occurred during an execution.
func (ActivityTimedOutEventDetails) String ¶
func (s ActivityTimedOutEventDetails) String() string
String returns the string representation
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS SFN. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := sfn.New(myConfig)
func (*Client) CreateActivityRequest ¶ added in v0.9.0
func (c *Client) CreateActivityRequest(input *CreateActivityInput) CreateActivityRequest
CreateActivityRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using CreateActivityRequest. req := client.CreateActivityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivity
func (*Client) CreateStateMachineRequest ¶ added in v0.9.0
func (c *Client) CreateStateMachineRequest(input *CreateStateMachineInput) CreateStateMachineRequest
CreateStateMachineRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using CreateStateMachineRequest. req := client.CreateStateMachineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachine
func (*Client) DeleteActivityRequest ¶ added in v0.9.0
func (c *Client) DeleteActivityRequest(input *DeleteActivityInput) DeleteActivityRequest
DeleteActivityRequest returns a request value for making API operation for AWS Step Functions.
Deletes an activity.
// Example sending a request using DeleteActivityRequest. req := client.DeleteActivityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity
func (*Client) DeleteStateMachineRequest ¶ added in v0.9.0
func (c *Client) DeleteStateMachineRequest(input *DeleteStateMachineInput) DeleteStateMachineRequest
DeleteStateMachineRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using DeleteStateMachineRequest. req := client.DeleteStateMachineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine
func (*Client) DescribeActivityRequest ¶ added in v0.9.0
func (c *Client) DescribeActivityRequest(input *DescribeActivityInput) DescribeActivityRequest
DescribeActivityRequest returns a request value for making API operation for AWS Step Functions.
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
// Example sending a request using DescribeActivityRequest. req := client.DescribeActivityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity
func (*Client) DescribeExecutionRequest ¶ added in v0.9.0
func (c *Client) DescribeExecutionRequest(input *DescribeExecutionInput) DescribeExecutionRequest
DescribeExecutionRequest returns a request value for making API operation for AWS Step Functions.
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
// Example sending a request using DescribeExecutionRequest. req := client.DescribeExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution
func (*Client) DescribeStateMachineForExecutionRequest ¶ added in v0.9.0
func (c *Client) DescribeStateMachineForExecutionRequest(input *DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest
DescribeStateMachineForExecutionRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using DescribeStateMachineForExecutionRequest. req := client.DescribeStateMachineForExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution
func (*Client) DescribeStateMachineRequest ¶ added in v0.9.0
func (c *Client) DescribeStateMachineRequest(input *DescribeStateMachineInput) DescribeStateMachineRequest
DescribeStateMachineRequest returns a request value for making API operation for AWS Step Functions.
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
// Example sending a request using DescribeStateMachineRequest. req := client.DescribeStateMachineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine
func (*Client) GetActivityTaskRequest ¶ added in v0.9.0
func (c *Client) GetActivityTaskRequest(input *GetActivityTaskInput) GetActivityTaskRequest
GetActivityTaskRequest returns a request value for making API operation for AWS Step Functions.
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 (https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html) in the Step Functions Developer Guide.
// Example sending a request using GetActivityTaskRequest. req := client.GetActivityTaskRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask
func (*Client) GetExecutionHistoryRequest ¶ added in v0.9.0
func (c *Client) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) GetExecutionHistoryRequest
GetExecutionHistoryRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using GetExecutionHistoryRequest. req := client.GetExecutionHistoryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory
func (*Client) ListActivitiesRequest ¶ added in v0.9.0
func (c *Client) ListActivitiesRequest(input *ListActivitiesInput) ListActivitiesRequest
ListActivitiesRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using ListActivitiesRequest. req := client.ListActivitiesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities
func (*Client) ListExecutionsRequest ¶ added in v0.9.0
func (c *Client) ListExecutionsRequest(input *ListExecutionsInput) ListExecutionsRequest
ListExecutionsRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using ListExecutionsRequest. req := client.ListExecutionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions
func (*Client) ListStateMachinesRequest ¶ added in v0.9.0
func (c *Client) ListStateMachinesRequest(input *ListStateMachinesInput) ListStateMachinesRequest
ListStateMachinesRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using ListStateMachinesRequest. req := client.ListStateMachinesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines
func (*Client) ListTagsForResourceRequest ¶ added in v0.9.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for AWS Step Functions.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListTagsForResource
func (*Client) SendTaskFailureRequest ¶ added in v0.9.0
func (c *Client) SendTaskFailureRequest(input *SendTaskFailureInput) SendTaskFailureRequest
SendTaskFailureRequest returns a request value for making API operation for AWS Step Functions.
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken failed.
// Example sending a request using SendTaskFailureRequest. req := client.SendTaskFailureRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailure
func (*Client) SendTaskHeartbeatRequest ¶ added in v0.9.0
func (c *Client) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) SendTaskHeartbeatRequest
SendTaskHeartbeatRequest returns a request value for making API operation for AWS Step Functions.
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) 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 (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) or callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) 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.
// Example sending a request using SendTaskHeartbeatRequest. req := client.SendTaskHeartbeatRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeat
func (*Client) SendTaskSuccessRequest ¶ added in v0.9.0
func (c *Client) SendTaskSuccessRequest(input *SendTaskSuccessInput) SendTaskSuccessRequest
SendTaskSuccessRequest returns a request value for making API operation for AWS Step Functions.
Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken completed successfully.
// Example sending a request using SendTaskSuccessRequest. req := client.SendTaskSuccessRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccess
func (*Client) StartExecutionRequest ¶ added in v0.9.0
func (c *Client) StartExecutionRequest(input *StartExecutionInput) StartExecutionRequest
StartExecutionRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using StartExecutionRequest. req := client.StartExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution
func (*Client) StopExecutionRequest ¶ added in v0.9.0
func (c *Client) StopExecutionRequest(input *StopExecutionInput) StopExecutionRequest
StopExecutionRequest returns a request value for making API operation for AWS Step Functions.
Stops an execution.
// Example sending a request using StopExecutionRequest. req := client.StopExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution
func (*Client) TagResourceRequest ¶ added in v0.9.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for AWS Step Functions.
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.9.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for AWS Step Functions.
Remove a tag from a Step Functions resource
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UntagResource
func (*Client) UpdateStateMachineRequest ¶ added in v0.9.0
func (c *Client) UpdateStateMachineRequest(input *UpdateStateMachineInput) UpdateStateMachineRequest
UpdateStateMachineRequest returns a request value for making API operation for AWS Step Functions.
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.
// Example sending a request using UpdateStateMachineRequest. req := client.UpdateStateMachineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachine
type CreateActivityInput ¶
type CreateActivityInput struct { // 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 (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The list of tags to add to a resource. // // An array of key-value pairs. For more information, see Using Cost Allocation // Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the AWS Billing and Cost Management User Guide, and Controlling Access // Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). // // Tags may only contain Unicode letters, digits, white space, or these symbols: // _ . : / = + - @. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
func (CreateActivityInput) String ¶
func (s CreateActivityInput) String() string
String returns the string representation
func (*CreateActivityInput) Validate ¶
func (s *CreateActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateActivityOutput ¶
type CreateActivityOutput struct { // The Amazon Resource Name (ARN) that identifies the created activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (CreateActivityOutput) String ¶
func (s CreateActivityOutput) String() string
String returns the string representation
type CreateActivityRequest ¶
type CreateActivityRequest struct { *aws.Request Input *CreateActivityInput Copy func(*CreateActivityInput) CreateActivityRequest }
CreateActivityRequest is the request type for the CreateActivity API operation.
func (CreateActivityRequest) Send ¶
func (r CreateActivityRequest) Send(ctx context.Context) (*CreateActivityResponse, error)
Send marshals and sends the CreateActivity API request.
type CreateActivityResponse ¶ added in v0.9.0
type CreateActivityResponse struct { *CreateActivityOutput // contains filtered or unexported fields }
CreateActivityResponse is the response type for the CreateActivity API operation.
func (*CreateActivityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateActivityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateActivity request.
type CreateStateMachineInput ¶
type CreateStateMachineInput struct { // The Amazon States Language definition of the state machine. See Amazon States // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role to use for this state machine. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // Tags to be added when creating a state machine. // // An array of key-value pairs. For more information, see Using Cost Allocation // Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the AWS Billing and Cost Management User Guide, and Controlling Access // Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). // // Tags may only contain Unicode letters, digits, white space, or these symbols: // _ . : / = + - @. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
func (CreateStateMachineInput) String ¶
func (s CreateStateMachineInput) String() string
String returns the string representation
func (*CreateStateMachineInput) Validate ¶
func (s *CreateStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStateMachineOutput ¶
type CreateStateMachineOutput struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // The Amazon Resource Name (ARN) that identifies the created state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateStateMachineOutput) String ¶
func (s CreateStateMachineOutput) String() string
String returns the string representation
type CreateStateMachineRequest ¶
type CreateStateMachineRequest struct { *aws.Request Input *CreateStateMachineInput Copy func(*CreateStateMachineInput) CreateStateMachineRequest }
CreateStateMachineRequest is the request type for the CreateStateMachine API operation.
func (CreateStateMachineRequest) Send ¶
func (r CreateStateMachineRequest) Send(ctx context.Context) (*CreateStateMachineResponse, error)
Send marshals and sends the CreateStateMachine API request.
type CreateStateMachineResponse ¶ added in v0.9.0
type CreateStateMachineResponse struct { *CreateStateMachineOutput // contains filtered or unexported fields }
CreateStateMachineResponse is the response type for the CreateStateMachine API operation.
func (*CreateStateMachineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateStateMachineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateStateMachine request.
type DeleteActivityInput ¶
type DeleteActivityInput struct { // The Amazon Resource Name (ARN) of the activity to delete. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteActivityInput) String ¶
func (s DeleteActivityInput) String() string
String returns the string representation
func (*DeleteActivityInput) Validate ¶
func (s *DeleteActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteActivityOutput ¶
type DeleteActivityOutput struct {
// contains filtered or unexported fields
}
func (DeleteActivityOutput) String ¶
func (s DeleteActivityOutput) String() string
String returns the string representation
type DeleteActivityRequest ¶
type DeleteActivityRequest struct { *aws.Request Input *DeleteActivityInput Copy func(*DeleteActivityInput) DeleteActivityRequest }
DeleteActivityRequest is the request type for the DeleteActivity API operation.
func (DeleteActivityRequest) Send ¶
func (r DeleteActivityRequest) Send(ctx context.Context) (*DeleteActivityResponse, error)
Send marshals and sends the DeleteActivity API request.
type DeleteActivityResponse ¶ added in v0.9.0
type DeleteActivityResponse struct { *DeleteActivityOutput // contains filtered or unexported fields }
DeleteActivityResponse is the response type for the DeleteActivity API operation.
func (*DeleteActivityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteActivityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteActivity request.
type DeleteStateMachineInput ¶
type DeleteStateMachineInput struct { // The Amazon Resource Name (ARN) of the state machine to delete. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteStateMachineInput) String ¶
func (s DeleteStateMachineInput) String() string
String returns the string representation
func (*DeleteStateMachineInput) Validate ¶
func (s *DeleteStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStateMachineOutput ¶
type DeleteStateMachineOutput struct {
// contains filtered or unexported fields
}
func (DeleteStateMachineOutput) String ¶
func (s DeleteStateMachineOutput) String() string
String returns the string representation
type DeleteStateMachineRequest ¶
type DeleteStateMachineRequest struct { *aws.Request Input *DeleteStateMachineInput Copy func(*DeleteStateMachineInput) DeleteStateMachineRequest }
DeleteStateMachineRequest is the request type for the DeleteStateMachine API operation.
func (DeleteStateMachineRequest) Send ¶
func (r DeleteStateMachineRequest) Send(ctx context.Context) (*DeleteStateMachineResponse, error)
Send marshals and sends the DeleteStateMachine API request.
type DeleteStateMachineResponse ¶ added in v0.9.0
type DeleteStateMachineResponse struct { *DeleteStateMachineOutput // contains filtered or unexported fields }
DeleteStateMachineResponse is the response type for the DeleteStateMachine API operation.
func (*DeleteStateMachineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteStateMachineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteStateMachine request.
type DescribeActivityInput ¶
type DescribeActivityInput struct { // The Amazon Resource Name (ARN) of the activity to describe. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeActivityInput) String ¶
func (s DescribeActivityInput) String() string
String returns the string representation
func (*DescribeActivityInput) Validate ¶
func (s *DescribeActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeActivityOutput ¶
type DescribeActivityOutput struct { // The Amazon Resource Name (ARN) that identifies the activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeActivityOutput) String ¶
func (s DescribeActivityOutput) String() string
String returns the string representation
type DescribeActivityRequest ¶
type DescribeActivityRequest struct { *aws.Request Input *DescribeActivityInput Copy func(*DescribeActivityInput) DescribeActivityRequest }
DescribeActivityRequest is the request type for the DescribeActivity API operation.
func (DescribeActivityRequest) Send ¶
func (r DescribeActivityRequest) Send(ctx context.Context) (*DescribeActivityResponse, error)
Send marshals and sends the DescribeActivity API request.
type DescribeActivityResponse ¶ added in v0.9.0
type DescribeActivityResponse struct { *DescribeActivityOutput // contains filtered or unexported fields }
DescribeActivityResponse is the response type for the DescribeActivity API operation.
func (*DescribeActivityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeActivityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeActivity request.
type DescribeExecutionInput ¶
type DescribeExecutionInput struct { // The Amazon Resource Name (ARN) of the execution to describe. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeExecutionInput) String ¶
func (s DescribeExecutionInput) String() string
String returns the string representation
func (*DescribeExecutionInput) Validate ¶
func (s *DescribeExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeExecutionOutput ¶
type DescribeExecutionOutput struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The string that contains the JSON input data of the execution. // // Input is a required field Input *string `locationName:"input" type:"string" required:"true"` // 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 *string `locationName:"name" min:"1" type:"string"` // 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 *string `locationName:"output" type:"string"` // The date the execution is started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` // The Amazon Resource Name (ARN) of the executed stated machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the execution. // // Status is a required field Status ExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"` // If the execution has already ended, the date the execution stopped. StopDate *time.Time `locationName:"stopDate" type:"timestamp"` // contains filtered or unexported fields }
func (DescribeExecutionOutput) String ¶
func (s DescribeExecutionOutput) String() string
String returns the string representation
type DescribeExecutionRequest ¶
type DescribeExecutionRequest struct { *aws.Request Input *DescribeExecutionInput Copy func(*DescribeExecutionInput) DescribeExecutionRequest }
DescribeExecutionRequest is the request type for the DescribeExecution API operation.
func (DescribeExecutionRequest) Send ¶
func (r DescribeExecutionRequest) Send(ctx context.Context) (*DescribeExecutionResponse, error)
Send marshals and sends the DescribeExecution API request.
type DescribeExecutionResponse ¶ added in v0.9.0
type DescribeExecutionResponse struct { *DescribeExecutionOutput // contains filtered or unexported fields }
DescribeExecutionResponse is the response type for the DescribeExecution API operation.
func (*DescribeExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeExecution request.
type DescribeStateMachineForExecutionInput ¶ added in v0.2.0
type DescribeStateMachineForExecutionInput struct { // The Amazon Resource Name (ARN) of the execution you want state machine information // for. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStateMachineForExecutionInput) String ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionInput) String() string
String returns the string representation
func (*DescribeStateMachineForExecutionInput) Validate ¶ added in v0.2.0
func (s *DescribeStateMachineForExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStateMachineForExecutionOutput ¶ added in v0.2.0
type DescribeStateMachineForExecutionOutput struct { // The Amazon States Language definition of the state machine. See Amazon States // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // The name of the state machine associated with the execution. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role of the State Machine for the // execution. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the state machine associated with the execution. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // 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 is a required field UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (DescribeStateMachineForExecutionOutput) String ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionOutput) String() string
String returns the string representation
type DescribeStateMachineForExecutionRequest ¶ added in v0.2.0
type DescribeStateMachineForExecutionRequest struct { *aws.Request Input *DescribeStateMachineForExecutionInput Copy func(*DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest }
DescribeStateMachineForExecutionRequest is the request type for the DescribeStateMachineForExecution API operation.
func (DescribeStateMachineForExecutionRequest) Send ¶ added in v0.2.0
func (r DescribeStateMachineForExecutionRequest) Send(ctx context.Context) (*DescribeStateMachineForExecutionResponse, error)
Send marshals and sends the DescribeStateMachineForExecution API request.
type DescribeStateMachineForExecutionResponse ¶ added in v0.9.0
type DescribeStateMachineForExecutionResponse struct { *DescribeStateMachineForExecutionOutput // contains filtered or unexported fields }
DescribeStateMachineForExecutionResponse is the response type for the DescribeStateMachineForExecution API operation.
func (*DescribeStateMachineForExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStateMachineForExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStateMachineForExecution request.
type DescribeStateMachineInput ¶
type DescribeStateMachineInput struct { // The Amazon Resource Name (ARN) of the state machine to describe. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStateMachineInput) String ¶
func (s DescribeStateMachineInput) String() string
String returns the string representation
func (*DescribeStateMachineInput) Validate ¶
func (s *DescribeStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStateMachineOutput ¶
type DescribeStateMachineOutput struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // The Amazon States Language definition of the state machine. See Amazon States // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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 is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) that identifies the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the state machine. Status StateMachineStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
func (DescribeStateMachineOutput) String ¶
func (s DescribeStateMachineOutput) String() string
String returns the string representation
type DescribeStateMachineRequest ¶
type DescribeStateMachineRequest struct { *aws.Request Input *DescribeStateMachineInput Copy func(*DescribeStateMachineInput) DescribeStateMachineRequest }
DescribeStateMachineRequest is the request type for the DescribeStateMachine API operation.
func (DescribeStateMachineRequest) Send ¶
func (r DescribeStateMachineRequest) Send(ctx context.Context) (*DescribeStateMachineResponse, error)
Send marshals and sends the DescribeStateMachine API request.
type DescribeStateMachineResponse ¶ added in v0.9.0
type DescribeStateMachineResponse struct { *DescribeStateMachineOutput // contains filtered or unexported fields }
DescribeStateMachineResponse is the response type for the DescribeStateMachine API operation.
func (*DescribeStateMachineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStateMachineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStateMachine request.
type ExecutionAbortedEventDetails ¶
type ExecutionAbortedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an abort of an execution.
func (ExecutionAbortedEventDetails) String ¶
func (s ExecutionAbortedEventDetails) String() string
String returns the string representation
type ExecutionFailedEventDetails ¶
type ExecutionFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an execution failure event.
func (ExecutionFailedEventDetails) String ¶
func (s ExecutionFailedEventDetails) String() string
String returns the string representation
type ExecutionListItem ¶
type ExecutionListItem struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The date the execution started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` // The Amazon Resource Name (ARN) of the executed state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the execution. // // Status is a required field Status ExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"` // If the execution already ended, the date the execution stopped. StopDate *time.Time `locationName:"stopDate" type:"timestamp"` // contains filtered or unexported fields }
Contains details about an execution.
func (ExecutionListItem) String ¶
func (s ExecutionListItem) String() string
String returns the string representation
type ExecutionStartedEventDetails ¶
type ExecutionStartedEventDetails struct { // The JSON data input to the execution. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda // tasks. RoleArn *string `locationName:"roleArn" min:"1" type:"string"` // contains filtered or unexported fields }
Contains details about the start of the execution.
func (ExecutionStartedEventDetails) String ¶
func (s ExecutionStartedEventDetails) String() string
String returns the string representation
type ExecutionStatus ¶
type ExecutionStatus string
const ( ExecutionStatusRunning ExecutionStatus = "RUNNING" ExecutionStatusSucceeded ExecutionStatus = "SUCCEEDED" ExecutionStatusFailed ExecutionStatus = "FAILED" ExecutionStatusTimedOut ExecutionStatus = "TIMED_OUT" ExecutionStatusAborted ExecutionStatus = "ABORTED" )
Enum values for ExecutionStatus
func (ExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValue() (string, error)
func (ExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ExecutionSucceededEventDetails ¶
type ExecutionSucceededEventDetails struct { // The JSON data output by the execution. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about the successful termination of the execution.
func (ExecutionSucceededEventDetails) String ¶
func (s ExecutionSucceededEventDetails) String() string
String returns the string representation
type ExecutionTimedOutEventDetails ¶
type ExecutionTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about the execution timeout that occurred during the execution.
func (ExecutionTimedOutEventDetails) String ¶
func (s ExecutionTimedOutEventDetails) String() string
String returns the string representation
type GetActivityTaskInput ¶
type GetActivityTaskInput struct { // The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned // when you create the task using CreateActivity.) // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // 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 *string `locationName:"workerName" min:"1" type:"string"` // contains filtered or unexported fields }
func (GetActivityTaskInput) String ¶
func (s GetActivityTaskInput) String() string
String returns the string representation
func (*GetActivityTaskInput) Validate ¶
func (s *GetActivityTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetActivityTaskOutput ¶
type GetActivityTaskOutput struct { // The string that contains the JSON input data for the task. Input *string `locationName:"input" type:"string"` // A token that identifies the scheduled task. This token must be copied and // included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure // in order to report the progress or completion of the task. TaskToken *string `locationName:"taskToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (GetActivityTaskOutput) String ¶
func (s GetActivityTaskOutput) String() string
String returns the string representation
type GetActivityTaskRequest ¶
type GetActivityTaskRequest struct { *aws.Request Input *GetActivityTaskInput Copy func(*GetActivityTaskInput) GetActivityTaskRequest }
GetActivityTaskRequest is the request type for the GetActivityTask API operation.
func (GetActivityTaskRequest) Send ¶
func (r GetActivityTaskRequest) Send(ctx context.Context) (*GetActivityTaskResponse, error)
Send marshals and sends the GetActivityTask API request.
type GetActivityTaskResponse ¶ added in v0.9.0
type GetActivityTaskResponse struct { *GetActivityTaskOutput // contains filtered or unexported fields }
GetActivityTaskResponse is the response type for the GetActivityTask API operation.
func (*GetActivityTaskResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetActivityTaskResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetActivityTask request.
type GetExecutionHistoryInput ¶
type GetExecutionHistoryInput struct { // The Amazon Resource Name (ARN) of the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // 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 *int64 `locationName:"maxResults" type:"integer"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // Lists events in descending order of their timeStamp. ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"` // contains filtered or unexported fields }
func (GetExecutionHistoryInput) String ¶
func (s GetExecutionHistoryInput) String() string
String returns the string representation
func (*GetExecutionHistoryInput) Validate ¶
func (s *GetExecutionHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExecutionHistoryOutput ¶
type GetExecutionHistoryOutput struct { // The list of events that occurred in the execution. // // Events is a required field Events []HistoryEvent `locationName:"events" type:"list" required:"true"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (GetExecutionHistoryOutput) String ¶
func (s GetExecutionHistoryOutput) String() string
String returns the string representation
type GetExecutionHistoryPaginator ¶ added in v0.9.0
GetExecutionHistoryPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetExecutionHistoryPaginator ¶ added in v0.9.0
func NewGetExecutionHistoryPaginator(req GetExecutionHistoryRequest) GetExecutionHistoryPaginator
NewGetExecutionHistoryRequestPaginator returns a paginator for GetExecutionHistory. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetExecutionHistoryRequest(input) p := sfn.NewGetExecutionHistoryRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetExecutionHistoryPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetExecutionHistoryPaginator) CurrentPage() *GetExecutionHistoryOutput
type GetExecutionHistoryRequest ¶
type GetExecutionHistoryRequest struct { *aws.Request Input *GetExecutionHistoryInput Copy func(*GetExecutionHistoryInput) GetExecutionHistoryRequest }
GetExecutionHistoryRequest is the request type for the GetExecutionHistory API operation.
func (GetExecutionHistoryRequest) Send ¶
func (r GetExecutionHistoryRequest) Send(ctx context.Context) (*GetExecutionHistoryResponse, error)
Send marshals and sends the GetExecutionHistory API request.
type GetExecutionHistoryResponse ¶ added in v0.9.0
type GetExecutionHistoryResponse struct { *GetExecutionHistoryOutput // contains filtered or unexported fields }
GetExecutionHistoryResponse is the response type for the GetExecutionHistory API operation.
func (*GetExecutionHistoryResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetExecutionHistoryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetExecutionHistory request.
type HistoryEvent ¶
type HistoryEvent struct { // Contains details about an activity that failed during an execution. ActivityFailedEventDetails *ActivityFailedEventDetails `locationName:"activityFailedEventDetails" type:"structure"` // Contains details about an activity schedule event that failed during an execution. ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails `locationName:"activityScheduleFailedEventDetails" type:"structure"` // Contains details about an activity scheduled during an execution. ActivityScheduledEventDetails *ActivityScheduledEventDetails `locationName:"activityScheduledEventDetails" type:"structure"` // Contains details about the start of an activity during an execution. ActivityStartedEventDetails *ActivityStartedEventDetails `locationName:"activityStartedEventDetails" type:"structure"` // Contains details about an activity that successfully terminated during an // execution. ActivitySucceededEventDetails *ActivitySucceededEventDetails `locationName:"activitySucceededEventDetails" type:"structure"` // Contains details about an activity timeout that occurred during an execution. ActivityTimedOutEventDetails *ActivityTimedOutEventDetails `locationName:"activityTimedOutEventDetails" type:"structure"` // Contains details about an abort of an execution. ExecutionAbortedEventDetails *ExecutionAbortedEventDetails `locationName:"executionAbortedEventDetails" type:"structure"` // Contains details about an execution failure event. ExecutionFailedEventDetails *ExecutionFailedEventDetails `locationName:"executionFailedEventDetails" type:"structure"` // Contains details about the start of the execution. ExecutionStartedEventDetails *ExecutionStartedEventDetails `locationName:"executionStartedEventDetails" type:"structure"` // Contains details about the successful termination of the execution. ExecutionSucceededEventDetails *ExecutionSucceededEventDetails `locationName:"executionSucceededEventDetails" type:"structure"` // Contains details about the execution timeout that occurred during the execution. ExecutionTimedOutEventDetails *ExecutionTimedOutEventDetails `locationName:"executionTimedOutEventDetails" type:"structure"` // The id of the event. Events are numbered sequentially, starting at one. // // Id is a required field Id *int64 `locationName:"id" type:"long" required:"true"` // Contains details about a lambda function that failed during an execution. LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails `locationName:"lambdaFunctionFailedEventDetails" type:"structure"` // Contains details about a failed lambda function schedule event that occurred // during an execution. LambdaFunctionScheduleFailedEventDetails *LambdaFunctionScheduleFailedEventDetails `locationName:"lambdaFunctionScheduleFailedEventDetails" type:"structure"` // Contains details about a lambda function scheduled during an execution. LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails `locationName:"lambdaFunctionScheduledEventDetails" type:"structure"` // Contains details about a lambda function that failed to start during an execution. LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails `locationName:"lambdaFunctionStartFailedEventDetails" type:"structure"` // Contains details about a lambda function that terminated successfully during // an execution. LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails `locationName:"lambdaFunctionSucceededEventDetails" type:"structure"` // Contains details about a lambda function timeout that occurred during an // execution. LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails `locationName:"lambdaFunctionTimedOutEventDetails" type:"structure"` // Contains details about an iteration of a Map state that was aborted. MapIterationAbortedEventDetails *MapIterationEventDetails `locationName:"mapIterationAbortedEventDetails" type:"structure"` // Contains details about an iteration of a Map state that failed. MapIterationFailedEventDetails *MapIterationEventDetails `locationName:"mapIterationFailedEventDetails" type:"structure"` // Contains details about an iteration of a Map state that was started. MapIterationStartedEventDetails *MapIterationEventDetails `locationName:"mapIterationStartedEventDetails" type:"structure"` // Contains details about an iteration of a Map state that succeeded. MapIterationSucceededEventDetails *MapIterationEventDetails `locationName:"mapIterationSucceededEventDetails" type:"structure"` // Contains details about Map state that was started. MapStateStartedEventDetails *MapStateStartedEventDetails `locationName:"mapStateStartedEventDetails" type:"structure"` // The id of the previous event. PreviousEventId *int64 `locationName:"previousEventId" type:"long"` // Contains details about a state entered during an execution. StateEnteredEventDetails *StateEnteredEventDetails `locationName:"stateEnteredEventDetails" type:"structure"` // Contains details about an exit from a state during an execution. StateExitedEventDetails *StateExitedEventDetails `locationName:"stateExitedEventDetails" type:"structure"` // Contains details about the failure of a task. TaskFailedEventDetails *TaskFailedEventDetails `locationName:"taskFailedEventDetails" type:"structure"` // Contains details about a task that was scheduled. TaskScheduledEventDetails *TaskScheduledEventDetails `locationName:"taskScheduledEventDetails" type:"structure"` // Contains details about a task that failed to start. TaskStartFailedEventDetails *TaskStartFailedEventDetails `locationName:"taskStartFailedEventDetails" type:"structure"` // Contains details about a task that was started. TaskStartedEventDetails *TaskStartedEventDetails `locationName:"taskStartedEventDetails" type:"structure"` // Contains details about a task that where the submit failed. TaskSubmitFailedEventDetails *TaskSubmitFailedEventDetails `locationName:"taskSubmitFailedEventDetails" type:"structure"` // Contains details about a submitted task. TaskSubmittedEventDetails *TaskSubmittedEventDetails `locationName:"taskSubmittedEventDetails" type:"structure"` // Contains details about a task that succeeded. TaskSucceededEventDetails *TaskSucceededEventDetails `locationName:"taskSucceededEventDetails" type:"structure"` // Contains details about a task that timed out. TaskTimedOutEventDetails *TaskTimedOutEventDetails `locationName:"taskTimedOutEventDetails" type:"structure"` // The date and time the event occurred. // // Timestamp is a required field Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"` // The type of the event. // // Type is a required field Type HistoryEventType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains details about the events of an execution.
func (HistoryEvent) String ¶
func (s HistoryEvent) String() string
String returns the string representation
type HistoryEventType ¶
type HistoryEventType string
const ( HistoryEventTypeActivityFailed HistoryEventType = "ActivityFailed" HistoryEventTypeActivityScheduled HistoryEventType = "ActivityScheduled" HistoryEventTypeActivityScheduleFailed HistoryEventType = "ActivityScheduleFailed" HistoryEventTypeActivityStarted HistoryEventType = "ActivityStarted" HistoryEventTypeActivitySucceeded HistoryEventType = "ActivitySucceeded" HistoryEventTypeActivityTimedOut HistoryEventType = "ActivityTimedOut" HistoryEventTypeChoiceStateEntered HistoryEventType = "ChoiceStateEntered" HistoryEventTypeChoiceStateExited HistoryEventType = "ChoiceStateExited" HistoryEventTypeExecutionAborted HistoryEventType = "ExecutionAborted" HistoryEventTypeExecutionFailed HistoryEventType = "ExecutionFailed" HistoryEventTypeExecutionStarted HistoryEventType = "ExecutionStarted" HistoryEventTypeExecutionSucceeded HistoryEventType = "ExecutionSucceeded" HistoryEventTypeExecutionTimedOut HistoryEventType = "ExecutionTimedOut" HistoryEventTypeFailStateEntered HistoryEventType = "FailStateEntered" HistoryEventTypeLambdaFunctionFailed HistoryEventType = "LambdaFunctionFailed" HistoryEventTypeLambdaFunctionScheduled HistoryEventType = "LambdaFunctionScheduled" HistoryEventTypeLambdaFunctionScheduleFailed HistoryEventType = "LambdaFunctionScheduleFailed" HistoryEventTypeLambdaFunctionStarted HistoryEventType = "LambdaFunctionStarted" HistoryEventTypeLambdaFunctionStartFailed HistoryEventType = "LambdaFunctionStartFailed" HistoryEventTypeLambdaFunctionSucceeded HistoryEventType = "LambdaFunctionSucceeded" HistoryEventTypeLambdaFunctionTimedOut HistoryEventType = "LambdaFunctionTimedOut" HistoryEventTypeMapIterationAborted HistoryEventType = "MapIterationAborted" HistoryEventTypeMapIterationFailed HistoryEventType = "MapIterationFailed" HistoryEventTypeMapIterationStarted HistoryEventType = "MapIterationStarted" HistoryEventTypeMapIterationSucceeded HistoryEventType = "MapIterationSucceeded" HistoryEventTypeMapStateAborted HistoryEventType = "MapStateAborted" HistoryEventTypeMapStateEntered HistoryEventType = "MapStateEntered" HistoryEventTypeMapStateExited HistoryEventType = "MapStateExited" HistoryEventTypeMapStateFailed HistoryEventType = "MapStateFailed" HistoryEventTypeMapStateStarted HistoryEventType = "MapStateStarted" HistoryEventTypeMapStateSucceeded HistoryEventType = "MapStateSucceeded" HistoryEventTypeParallelStateAborted HistoryEventType = "ParallelStateAborted" HistoryEventTypeParallelStateEntered HistoryEventType = "ParallelStateEntered" HistoryEventTypeParallelStateExited HistoryEventType = "ParallelStateExited" HistoryEventTypeParallelStateFailed HistoryEventType = "ParallelStateFailed" HistoryEventTypeParallelStateStarted HistoryEventType = "ParallelStateStarted" HistoryEventTypeParallelStateSucceeded HistoryEventType = "ParallelStateSucceeded" HistoryEventTypePassStateEntered HistoryEventType = "PassStateEntered" HistoryEventTypePassStateExited HistoryEventType = "PassStateExited" HistoryEventTypeSucceedStateEntered HistoryEventType = "SucceedStateEntered" HistoryEventTypeSucceedStateExited HistoryEventType = "SucceedStateExited" HistoryEventTypeTaskFailed HistoryEventType = "TaskFailed" HistoryEventTypeTaskScheduled HistoryEventType = "TaskScheduled" HistoryEventTypeTaskStarted HistoryEventType = "TaskStarted" HistoryEventTypeTaskStartFailed HistoryEventType = "TaskStartFailed" HistoryEventTypeTaskStateAborted HistoryEventType = "TaskStateAborted" HistoryEventTypeTaskStateEntered HistoryEventType = "TaskStateEntered" HistoryEventTypeTaskStateExited HistoryEventType = "TaskStateExited" HistoryEventTypeTaskSubmitFailed HistoryEventType = "TaskSubmitFailed" HistoryEventTypeTaskSubmitted HistoryEventType = "TaskSubmitted" HistoryEventTypeTaskSucceeded HistoryEventType = "TaskSucceeded" HistoryEventTypeTaskTimedOut HistoryEventType = "TaskTimedOut" HistoryEventTypeWaitStateAborted HistoryEventType = "WaitStateAborted" HistoryEventTypeWaitStateEntered HistoryEventType = "WaitStateEntered" HistoryEventTypeWaitStateExited HistoryEventType = "WaitStateExited" )
Enum values for HistoryEventType
func (HistoryEventType) MarshalValue ¶ added in v0.3.0
func (enum HistoryEventType) MarshalValue() (string, error)
func (HistoryEventType) MarshalValueBuf ¶ added in v0.3.0
func (enum HistoryEventType) MarshalValueBuf(b []byte) ([]byte, error)
type LambdaFunctionFailedEventDetails ¶
type LambdaFunctionFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function that failed during an execution.
func (LambdaFunctionFailedEventDetails) String ¶
func (s LambdaFunctionFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionScheduleFailedEventDetails ¶
type LambdaFunctionScheduleFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a failed lambda function schedule event that occurred during an execution.
func (LambdaFunctionScheduleFailedEventDetails) String ¶
func (s LambdaFunctionScheduleFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionScheduledEventDetails ¶
type LambdaFunctionScheduledEventDetails struct { // The JSON data input to the lambda function. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the scheduled lambda function. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The maximum allowed duration of the lambda function. TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` // contains filtered or unexported fields }
Contains details about a lambda function scheduled during an execution.
func (LambdaFunctionScheduledEventDetails) String ¶
func (s LambdaFunctionScheduledEventDetails) String() string
String returns the string representation
type LambdaFunctionStartFailedEventDetails ¶
type LambdaFunctionStartFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function that failed to start during an execution.
func (LambdaFunctionStartFailedEventDetails) String ¶
func (s LambdaFunctionStartFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionSucceededEventDetails ¶
type LambdaFunctionSucceededEventDetails struct { // The JSON data output by the lambda function. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function that successfully terminated during an execution.
func (LambdaFunctionSucceededEventDetails) String ¶
func (s LambdaFunctionSucceededEventDetails) String() string
String returns the string representation
type LambdaFunctionTimedOutEventDetails ¶
type LambdaFunctionTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function timeout that occurred during an execution.
func (LambdaFunctionTimedOutEventDetails) String ¶
func (s LambdaFunctionTimedOutEventDetails) String() string
String returns the string representation
type ListActivitiesInput ¶
type ListActivitiesInput struct { // 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 *int64 `locationName:"maxResults" type:"integer"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListActivitiesInput) String ¶
func (s ListActivitiesInput) String() string
String returns the string representation
func (*ListActivitiesInput) Validate ¶
func (s *ListActivitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListActivitiesOutput ¶
type ListActivitiesOutput struct { // The list of activities. // // Activities is a required field Activities []ActivityListItem `locationName:"activities" type:"list" required:"true"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListActivitiesOutput) String ¶
func (s ListActivitiesOutput) String() string
String returns the string representation
type ListActivitiesPaginator ¶ added in v0.9.0
ListActivitiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListActivitiesPaginator ¶ added in v0.9.0
func NewListActivitiesPaginator(req ListActivitiesRequest) ListActivitiesPaginator
NewListActivitiesRequestPaginator returns a paginator for ListActivities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListActivitiesRequest(input) p := sfn.NewListActivitiesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListActivitiesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListActivitiesPaginator) CurrentPage() *ListActivitiesOutput
type ListActivitiesRequest ¶
type ListActivitiesRequest struct { *aws.Request Input *ListActivitiesInput Copy func(*ListActivitiesInput) ListActivitiesRequest }
ListActivitiesRequest is the request type for the ListActivities API operation.
func (ListActivitiesRequest) Send ¶
func (r ListActivitiesRequest) Send(ctx context.Context) (*ListActivitiesResponse, error)
Send marshals and sends the ListActivities API request.
type ListActivitiesResponse ¶ added in v0.9.0
type ListActivitiesResponse struct { *ListActivitiesOutput // contains filtered or unexported fields }
ListActivitiesResponse is the response type for the ListActivities API operation.
func (*ListActivitiesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListActivitiesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListActivities request.
type ListExecutionsInput ¶
type ListExecutionsInput struct { // 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 *int64 `locationName:"maxResults" type:"integer"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine whose executions is listed. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // If specified, only list the executions whose current execution status matches // the given filter. StatusFilter ExecutionStatus `locationName:"statusFilter" type:"string" enum:"true"` // contains filtered or unexported fields }
func (ListExecutionsInput) String ¶
func (s ListExecutionsInput) String() string
String returns the string representation
func (*ListExecutionsInput) Validate ¶
func (s *ListExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListExecutionsOutput ¶
type ListExecutionsOutput struct { // The list of matching executions. // // Executions is a required field Executions []ExecutionListItem `locationName:"executions" type:"list" required:"true"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListExecutionsOutput) String ¶
func (s ListExecutionsOutput) String() string
String returns the string representation
type ListExecutionsPaginator ¶ added in v0.9.0
ListExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListExecutionsPaginator ¶ added in v0.9.0
func NewListExecutionsPaginator(req ListExecutionsRequest) ListExecutionsPaginator
NewListExecutionsRequestPaginator returns a paginator for ListExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListExecutionsRequest(input) p := sfn.NewListExecutionsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListExecutionsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListExecutionsPaginator) CurrentPage() *ListExecutionsOutput
type ListExecutionsRequest ¶
type ListExecutionsRequest struct { *aws.Request Input *ListExecutionsInput Copy func(*ListExecutionsInput) ListExecutionsRequest }
ListExecutionsRequest is the request type for the ListExecutions API operation.
func (ListExecutionsRequest) Send ¶
func (r ListExecutionsRequest) Send(ctx context.Context) (*ListExecutionsResponse, error)
Send marshals and sends the ListExecutions API request.
type ListExecutionsResponse ¶ added in v0.9.0
type ListExecutionsResponse struct { *ListExecutionsOutput // contains filtered or unexported fields }
ListExecutionsResponse is the response type for the ListExecutions API operation.
func (*ListExecutionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListExecutionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListExecutions request.
type ListStateMachinesInput ¶
type ListStateMachinesInput struct { // 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 *int64 `locationName:"maxResults" type:"integer"` // 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 *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListStateMachinesInput) String ¶
func (s ListStateMachinesInput) String() string
String returns the string representation
func (*ListStateMachinesInput) Validate ¶
func (s *ListStateMachinesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStateMachinesOutput ¶
type ListStateMachinesOutput struct { // 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 *string `locationName:"nextToken" min:"1" type:"string"` // StateMachines is a required field StateMachines []StateMachineListItem `locationName:"stateMachines" type:"list" required:"true"` // contains filtered or unexported fields }
func (ListStateMachinesOutput) String ¶
func (s ListStateMachinesOutput) String() string
String returns the string representation
type ListStateMachinesPaginator ¶ added in v0.9.0
ListStateMachinesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListStateMachinesPaginator ¶ added in v0.9.0
func NewListStateMachinesPaginator(req ListStateMachinesRequest) ListStateMachinesPaginator
NewListStateMachinesRequestPaginator returns a paginator for ListStateMachines. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListStateMachinesRequest(input) p := sfn.NewListStateMachinesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListStateMachinesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListStateMachinesPaginator) CurrentPage() *ListStateMachinesOutput
type ListStateMachinesRequest ¶
type ListStateMachinesRequest struct { *aws.Request Input *ListStateMachinesInput Copy func(*ListStateMachinesInput) ListStateMachinesRequest }
ListStateMachinesRequest is the request type for the ListStateMachines API operation.
func (ListStateMachinesRequest) Send ¶
func (r ListStateMachinesRequest) Send(ctx context.Context) (*ListStateMachinesResponse, error)
Send marshals and sends the ListStateMachines API request.
type ListStateMachinesResponse ¶ added in v0.9.0
type ListStateMachinesResponse struct { *ListStateMachinesOutput // contains filtered or unexported fields }
ListStateMachinesResponse is the response type for the ListStateMachines API operation.
func (*ListStateMachinesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStateMachinesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStateMachines request.
type ListTagsForResourceInput ¶ added in v0.7.0
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) String ¶ added in v0.7.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.7.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.7.0
type ListTagsForResourceOutput struct { // An array of tags associated with the resource. Tags []Tag `locationName:"tags" type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) String ¶ added in v0.7.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶ added in v0.7.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.7.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.9.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type MapIterationEventDetails ¶ added in v0.12.0
type MapIterationEventDetails struct { // The index of the array belonging to the Map state iteration. Index *int64 `locationName:"index" type:"integer"` // The name of the iteration’s parent Map state. Name *string `locationName:"name" min:"1" type:"string"` // contains filtered or unexported fields }
Contains details about an iteration of a Map state.
func (MapIterationEventDetails) String ¶ added in v0.12.0
func (s MapIterationEventDetails) String() string
String returns the string representation
type MapStateStartedEventDetails ¶ added in v0.12.0
type MapStateStartedEventDetails struct { // The size of the array for Map state iterations. Length *int64 `locationName:"length" type:"integer"` // contains filtered or unexported fields }
Details about a Map state that was started.
func (MapStateStartedEventDetails) String ¶ added in v0.12.0
func (s MapStateStartedEventDetails) String() string
String returns the string representation
type SendTaskFailureInput ¶
type SendTaskFailureInput struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The token that represents this task. Task tokens are generated by Step Functions // when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (SendTaskFailureInput) String ¶
func (s SendTaskFailureInput) String() string
String returns the string representation
func (*SendTaskFailureInput) Validate ¶
func (s *SendTaskFailureInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskFailureOutput ¶
type SendTaskFailureOutput struct {
// contains filtered or unexported fields
}
func (SendTaskFailureOutput) String ¶
func (s SendTaskFailureOutput) String() string
String returns the string representation
type SendTaskFailureRequest ¶
type SendTaskFailureRequest struct { *aws.Request Input *SendTaskFailureInput Copy func(*SendTaskFailureInput) SendTaskFailureRequest }
SendTaskFailureRequest is the request type for the SendTaskFailure API operation.
func (SendTaskFailureRequest) Send ¶
func (r SendTaskFailureRequest) Send(ctx context.Context) (*SendTaskFailureResponse, error)
Send marshals and sends the SendTaskFailure API request.
type SendTaskFailureResponse ¶ added in v0.9.0
type SendTaskFailureResponse struct { *SendTaskFailureOutput // contains filtered or unexported fields }
SendTaskFailureResponse is the response type for the SendTaskFailure API operation.
func (*SendTaskFailureResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SendTaskFailureResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendTaskFailure request.
type SendTaskHeartbeatInput ¶
type SendTaskHeartbeatInput struct { // The token that represents this task. Task tokens are generated by Step Functions // when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (SendTaskHeartbeatInput) String ¶
func (s SendTaskHeartbeatInput) String() string
String returns the string representation
func (*SendTaskHeartbeatInput) Validate ¶
func (s *SendTaskHeartbeatInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskHeartbeatOutput ¶
type SendTaskHeartbeatOutput struct {
// contains filtered or unexported fields
}
func (SendTaskHeartbeatOutput) String ¶
func (s SendTaskHeartbeatOutput) String() string
String returns the string representation
type SendTaskHeartbeatRequest ¶
type SendTaskHeartbeatRequest struct { *aws.Request Input *SendTaskHeartbeatInput Copy func(*SendTaskHeartbeatInput) SendTaskHeartbeatRequest }
SendTaskHeartbeatRequest is the request type for the SendTaskHeartbeat API operation.
func (SendTaskHeartbeatRequest) Send ¶
func (r SendTaskHeartbeatRequest) Send(ctx context.Context) (*SendTaskHeartbeatResponse, error)
Send marshals and sends the SendTaskHeartbeat API request.
type SendTaskHeartbeatResponse ¶ added in v0.9.0
type SendTaskHeartbeatResponse struct { *SendTaskHeartbeatOutput // contains filtered or unexported fields }
SendTaskHeartbeatResponse is the response type for the SendTaskHeartbeat API operation.
func (*SendTaskHeartbeatResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SendTaskHeartbeatResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendTaskHeartbeat request.
type SendTaskSuccessInput ¶
type SendTaskSuccessInput struct { // The JSON output of the task. // // Output is a required field Output *string `locationName:"output" type:"string" required:"true"` // The token that represents this task. Task tokens are generated by Step Functions // when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (SendTaskSuccessInput) String ¶
func (s SendTaskSuccessInput) String() string
String returns the string representation
func (*SendTaskSuccessInput) Validate ¶
func (s *SendTaskSuccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskSuccessOutput ¶
type SendTaskSuccessOutput struct {
// contains filtered or unexported fields
}
func (SendTaskSuccessOutput) String ¶
func (s SendTaskSuccessOutput) String() string
String returns the string representation
type SendTaskSuccessRequest ¶
type SendTaskSuccessRequest struct { *aws.Request Input *SendTaskSuccessInput Copy func(*SendTaskSuccessInput) SendTaskSuccessRequest }
SendTaskSuccessRequest is the request type for the SendTaskSuccess API operation.
func (SendTaskSuccessRequest) Send ¶
func (r SendTaskSuccessRequest) Send(ctx context.Context) (*SendTaskSuccessResponse, error)
Send marshals and sends the SendTaskSuccess API request.
type SendTaskSuccessResponse ¶ added in v0.9.0
type SendTaskSuccessResponse struct { *SendTaskSuccessOutput // contains filtered or unexported fields }
SendTaskSuccessResponse is the response type for the SendTaskSuccess API operation.
func (*SendTaskSuccessResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SendTaskSuccessResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendTaskSuccess request.
type StartExecutionInput ¶
type StartExecutionInput struct { // The string that contains the JSON input data for the execution, for example: // // "input": "{\"first_name\" : \"test\"}" // // If you don't include any JSON input data, you still must include the two // braces, for example: "input": "{}" Input *string `locationName:"input" type:"string"` // The name of the execution. This name must be unique for your AWS account, // region, and state machine for 90 days. For more information, see Limits Related // to State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-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 *string `locationName:"name" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine to execute. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (StartExecutionInput) String ¶
func (s StartExecutionInput) String() string
String returns the string representation
func (*StartExecutionInput) Validate ¶
func (s *StartExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartExecutionOutput ¶
type StartExecutionOutput struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The date the execution is started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (StartExecutionOutput) String ¶
func (s StartExecutionOutput) String() string
String returns the string representation
type StartExecutionRequest ¶
type StartExecutionRequest struct { *aws.Request Input *StartExecutionInput Copy func(*StartExecutionInput) StartExecutionRequest }
StartExecutionRequest is the request type for the StartExecution API operation.
func (StartExecutionRequest) Send ¶
func (r StartExecutionRequest) Send(ctx context.Context) (*StartExecutionResponse, error)
Send marshals and sends the StartExecution API request.
type StartExecutionResponse ¶ added in v0.9.0
type StartExecutionResponse struct { *StartExecutionOutput // contains filtered or unexported fields }
StartExecutionResponse is the response type for the StartExecution API operation.
func (*StartExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StartExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartExecution request.
type StateEnteredEventDetails ¶
type StateEnteredEventDetails struct { // The string that contains the JSON input data for the state. Input *string `locationName:"input" type:"string"` // The name of the state. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a state entered during an execution.
func (StateEnteredEventDetails) String ¶
func (s StateEnteredEventDetails) String() string
String returns the string representation
type StateExitedEventDetails ¶
type StateExitedEventDetails struct { // The name of the state. // // A name must not contain: // // * white space // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The JSON output data of the state. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about an exit from a state during an execution.
func (StateExitedEventDetails) String ¶
func (s StateExitedEventDetails) String() string
String returns the string representation
type StateMachineListItem ¶
type StateMachineListItem struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // 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 is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) that identifies the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about the state machine.
func (StateMachineListItem) String ¶
func (s StateMachineListItem) String() string
String returns the string representation
type StateMachineStatus ¶
type StateMachineStatus string
const ( StateMachineStatusActive StateMachineStatus = "ACTIVE" StateMachineStatusDeleting StateMachineStatus = "DELETING" )
Enum values for StateMachineStatus
func (StateMachineStatus) MarshalValue ¶ added in v0.3.0
func (enum StateMachineStatus) MarshalValue() (string, error)
func (StateMachineStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StateMachineStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StopExecutionInput ¶
type StopExecutionInput struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The Amazon Resource Name (ARN) of the execution to stop. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (StopExecutionInput) String ¶
func (s StopExecutionInput) String() string
String returns the string representation
func (*StopExecutionInput) Validate ¶
func (s *StopExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopExecutionOutput ¶
type StopExecutionOutput struct { // The date the execution is stopped. // // StopDate is a required field StopDate *time.Time `locationName:"stopDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (StopExecutionOutput) String ¶
func (s StopExecutionOutput) String() string
String returns the string representation
type StopExecutionRequest ¶
type StopExecutionRequest struct { *aws.Request Input *StopExecutionInput Copy func(*StopExecutionInput) StopExecutionRequest }
StopExecutionRequest is the request type for the StopExecution API operation.
func (StopExecutionRequest) Send ¶
func (r StopExecutionRequest) Send(ctx context.Context) (*StopExecutionResponse, error)
Send marshals and sends the StopExecution API request.
type StopExecutionResponse ¶ added in v0.9.0
type StopExecutionResponse struct { *StopExecutionOutput // contains filtered or unexported fields }
StopExecutionResponse is the response type for the StopExecution API operation.
func (*StopExecutionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StopExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StopExecution request.
type Tag ¶ added in v0.7.0
type Tag struct { // The key of a tag. Key *string `locationName:"key" min:"1" type:"string"` // The value of a tag. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
type TagResourceInput ¶ added in v0.7.0
type TagResourceInput struct { // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` // The list of tags to add to a resource. // // Tags may only contain Unicode letters, digits, white space, or these symbols: // _ . : / = + - @. // // Tags is a required field Tags []Tag `locationName:"tags" type:"list" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) String ¶ added in v0.7.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.7.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.7.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) String ¶ added in v0.7.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.7.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.7.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.9.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type TaskFailedEventDetails ¶ added in v0.6.0
type TaskFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a task failure event.
func (TaskFailedEventDetails) String ¶ added in v0.6.0
func (s TaskFailedEventDetails) String() string
String returns the string representation
type TaskScheduledEventDetails ¶ added in v0.6.0
type TaskScheduledEventDetails struct { // The JSON data passed to the resource referenced in a task state. // // Parameters is a required field Parameters *string `locationName:"parameters" type:"string" required:"true"` // The region of the scheduled task // // Region is a required field Region *string `locationName:"region" min:"1" type:"string" required:"true"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // The maximum allowed duration of the task. TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` // contains filtered or unexported fields }
Contains details about a task scheduled during an execution.
func (TaskScheduledEventDetails) String ¶ added in v0.6.0
func (s TaskScheduledEventDetails) String() string
String returns the string representation
type TaskStartFailedEventDetails ¶ added in v0.6.0
type TaskStartFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a task that failed to start during an execution.
func (TaskStartFailedEventDetails) String ¶ added in v0.6.0
func (s TaskStartFailedEventDetails) String() string
String returns the string representation
type TaskStartedEventDetails ¶ added in v0.6.0
type TaskStartedEventDetails struct { // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about the start of a task during an execution.
func (TaskStartedEventDetails) String ¶ added in v0.6.0
func (s TaskStartedEventDetails) String() string
String returns the string representation
type TaskSubmitFailedEventDetails ¶ added in v0.6.0
type TaskSubmitFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a task that failed to submit during an execution.
func (TaskSubmitFailedEventDetails) String ¶ added in v0.6.0
func (s TaskSubmitFailedEventDetails) String() string
String returns the string representation
type TaskSubmittedEventDetails ¶ added in v0.6.0
type TaskSubmittedEventDetails struct { // The response from a resource when a task has started. Output *string `locationName:"output" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a task submitted to a resource .
func (TaskSubmittedEventDetails) String ¶ added in v0.6.0
func (s TaskSubmittedEventDetails) String() string
String returns the string representation
type TaskSucceededEventDetails ¶ added in v0.6.0
type TaskSucceededEventDetails struct { // The full JSON response from a resource when a task has succeeded. This response // becomes the output of the related task. Output *string `locationName:"output" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about the successful completion of a task state.
func (TaskSucceededEventDetails) String ¶ added in v0.6.0
func (s TaskSucceededEventDetails) String() string
String returns the string representation
type TaskTimedOutEventDetails ¶ added in v0.6.0
type TaskTimedOutEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // The service name of the resource in a task state. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The action of the resource called by a task state. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a resource timeout that occurred during an execution.
func (TaskTimedOutEventDetails) String ¶ added in v0.6.0
func (s TaskTimedOutEventDetails) String() string
String returns the string representation
type UntagResourceInput ¶ added in v0.7.0
type UntagResourceInput struct { // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` // The list of tags to remove from the resource. // // TagKeys is a required field TagKeys []string `locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) String ¶ added in v0.7.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.7.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.7.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) String ¶ added in v0.7.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.7.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.7.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.9.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateStateMachineInput ¶ added in v0.2.0
type UpdateStateMachineInput struct { // The Amazon States Language definition of the state machine. See Amazon States // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). Definition *string `locationName:"definition" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the IAM role of the state machine. RoleArn *string `locationName:"roleArn" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateStateMachineInput) String ¶ added in v0.2.0
func (s UpdateStateMachineInput) String() string
String returns the string representation
func (*UpdateStateMachineInput) Validate ¶ added in v0.2.0
func (s *UpdateStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStateMachineOutput ¶ added in v0.2.0
type UpdateStateMachineOutput struct { // The date and time the state machine was updated. // // UpdateDate is a required field UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (UpdateStateMachineOutput) String ¶ added in v0.2.0
func (s UpdateStateMachineOutput) String() string
String returns the string representation
type UpdateStateMachineRequest ¶ added in v0.2.0
type UpdateStateMachineRequest struct { *aws.Request Input *UpdateStateMachineInput Copy func(*UpdateStateMachineInput) UpdateStateMachineRequest }
UpdateStateMachineRequest is the request type for the UpdateStateMachine API operation.
func (UpdateStateMachineRequest) Send ¶ added in v0.2.0
func (r UpdateStateMachineRequest) Send(ctx context.Context) (*UpdateStateMachineResponse, error)
Send marshals and sends the UpdateStateMachine API request.
type UpdateStateMachineResponse ¶ added in v0.9.0
type UpdateStateMachineResponse struct { *UpdateStateMachineOutput // contains filtered or unexported fields }
UpdateStateMachineResponse is the response type for the UpdateStateMachine API operation.
func (*UpdateStateMachineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateStateMachineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateStateMachine request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateActivity.go
- api_op_CreateStateMachine.go
- api_op_DeleteActivity.go
- api_op_DeleteStateMachine.go
- api_op_DescribeActivity.go
- api_op_DescribeExecution.go
- api_op_DescribeStateMachine.go
- api_op_DescribeStateMachineForExecution.go
- api_op_GetActivityTask.go
- api_op_GetExecutionHistory.go
- api_op_ListActivities.go
- api_op_ListExecutions.go
- api_op_ListStateMachines.go
- api_op_ListTagsForResource.go
- api_op_SendTaskFailure.go
- api_op_SendTaskHeartbeat.go
- api_op_SendTaskSuccess.go
- api_op_StartExecution.go
- api_op_StopExecution.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateStateMachine.go
- api_types.go