sfn

package
v1.6.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 27, 2017 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package sfn provides a client for AWS Step Functions.

Index

Examples

Constants

View Source
const (
	// ExecutionStatusRunning is a ExecutionStatus enum value
	ExecutionStatusRunning = "RUNNING"

	// ExecutionStatusSucceeded is a ExecutionStatus enum value
	ExecutionStatusSucceeded = "SUCCEEDED"

	// ExecutionStatusFailed is a ExecutionStatus enum value
	ExecutionStatusFailed = "FAILED"

	// ExecutionStatusTimedOut is a ExecutionStatus enum value
	ExecutionStatusTimedOut = "TIMED_OUT"

	// ExecutionStatusAborted is a ExecutionStatus enum value
	ExecutionStatusAborted = "ABORTED"
)
View Source
const (
	// HistoryEventTypeActivityFailed is a HistoryEventType enum value
	HistoryEventTypeActivityFailed = "ActivityFailed"

	// HistoryEventTypeActivityScheduleFailed is a HistoryEventType enum value
	HistoryEventTypeActivityScheduleFailed = "ActivityScheduleFailed"

	// HistoryEventTypeActivityScheduled is a HistoryEventType enum value
	HistoryEventTypeActivityScheduled = "ActivityScheduled"

	// HistoryEventTypeActivityStarted is a HistoryEventType enum value
	HistoryEventTypeActivityStarted = "ActivityStarted"

	// HistoryEventTypeActivitySucceeded is a HistoryEventType enum value
	HistoryEventTypeActivitySucceeded = "ActivitySucceeded"

	// HistoryEventTypeActivityTimedOut is a HistoryEventType enum value
	HistoryEventTypeActivityTimedOut = "ActivityTimedOut"

	// HistoryEventTypeChoiceStateEntered is a HistoryEventType enum value
	HistoryEventTypeChoiceStateEntered = "ChoiceStateEntered"

	// HistoryEventTypeChoiceStateExited is a HistoryEventType enum value
	HistoryEventTypeChoiceStateExited = "ChoiceStateExited"

	// HistoryEventTypeExecutionFailed is a HistoryEventType enum value
	HistoryEventTypeExecutionFailed = "ExecutionFailed"

	// HistoryEventTypeExecutionStarted is a HistoryEventType enum value
	HistoryEventTypeExecutionStarted = "ExecutionStarted"

	// HistoryEventTypeExecutionSucceeded is a HistoryEventType enum value
	HistoryEventTypeExecutionSucceeded = "ExecutionSucceeded"

	// HistoryEventTypeExecutionAborted is a HistoryEventType enum value
	HistoryEventTypeExecutionAborted = "ExecutionAborted"

	// HistoryEventTypeExecutionTimedOut is a HistoryEventType enum value
	HistoryEventTypeExecutionTimedOut = "ExecutionTimedOut"

	// HistoryEventTypeFailStateEntered is a HistoryEventType enum value
	HistoryEventTypeFailStateEntered = "FailStateEntered"

	// HistoryEventTypeLambdaFunctionFailed is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionFailed = "LambdaFunctionFailed"

	// HistoryEventTypeLambdaFunctionScheduleFailed is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionScheduleFailed = "LambdaFunctionScheduleFailed"

	// HistoryEventTypeLambdaFunctionScheduled is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionScheduled = "LambdaFunctionScheduled"

	// HistoryEventTypeLambdaFunctionStartFailed is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionStartFailed = "LambdaFunctionStartFailed"

	// HistoryEventTypeLambdaFunctionStarted is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionStarted = "LambdaFunctionStarted"

	// HistoryEventTypeLambdaFunctionSucceeded is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionSucceeded = "LambdaFunctionSucceeded"

	// HistoryEventTypeLambdaFunctionTimedOut is a HistoryEventType enum value
	HistoryEventTypeLambdaFunctionTimedOut = "LambdaFunctionTimedOut"

	// HistoryEventTypeSucceedStateEntered is a HistoryEventType enum value
	HistoryEventTypeSucceedStateEntered = "SucceedStateEntered"

	// HistoryEventTypeSucceedStateExited is a HistoryEventType enum value
	HistoryEventTypeSucceedStateExited = "SucceedStateExited"

	// HistoryEventTypeTaskStateEntered is a HistoryEventType enum value
	HistoryEventTypeTaskStateEntered = "TaskStateEntered"

	// HistoryEventTypeTaskStateExited is a HistoryEventType enum value
	HistoryEventTypeTaskStateExited = "TaskStateExited"

	// HistoryEventTypePassStateEntered is a HistoryEventType enum value
	HistoryEventTypePassStateEntered = "PassStateEntered"

	// HistoryEventTypePassStateExited is a HistoryEventType enum value
	HistoryEventTypePassStateExited = "PassStateExited"

	// HistoryEventTypeParallelStateEntered is a HistoryEventType enum value
	HistoryEventTypeParallelStateEntered = "ParallelStateEntered"

	// HistoryEventTypeParallelStateExited is a HistoryEventType enum value
	HistoryEventTypeParallelStateExited = "ParallelStateExited"

	// HistoryEventTypeWaitStateEntered is a HistoryEventType enum value
	HistoryEventTypeWaitStateEntered = "WaitStateEntered"

	// HistoryEventTypeWaitStateExited is a HistoryEventType enum value
	HistoryEventTypeWaitStateExited = "WaitStateExited"
)
View Source
const (
	// StateMachineStatusActive is a StateMachineStatus enum value
	StateMachineStatusActive = "ACTIVE"

	// StateMachineStatusDeleting is a StateMachineStatus enum value
	StateMachineStatusDeleting = "DELETING"
)
View Source
const (
	ServiceName = "states"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityFailedEventDetails

func (ActivityFailedEventDetails) GoString

func (s ActivityFailedEventDetails) GoString() string

GoString returns the string representation

func (*ActivityFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ActivityFailedEventDetails) SetError

SetError sets the Error field's value.

func (ActivityFailedEventDetails) 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 was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The name of the activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityListItem

func (ActivityListItem) GoString

func (s ActivityListItem) GoString() string

GoString returns the string representation

func (*ActivityListItem) SetActivityArn

func (s *ActivityListItem) SetActivityArn(v string) *ActivityListItem

SetActivityArn sets the ActivityArn field's value.

func (*ActivityListItem) SetCreationDate

func (s *ActivityListItem) SetCreationDate(v time.Time) *ActivityListItem

SetCreationDate sets the CreationDate field's value.

func (*ActivityListItem) SetName

func (s *ActivityListItem) SetName(v string) *ActivityListItem

SetName sets the Name field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduleFailedEventDetails

func (ActivityScheduleFailedEventDetails) GoString

GoString returns the string representation

func (*ActivityScheduleFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ActivityScheduleFailedEventDetails) SetError

SetError sets the Error field's value.

func (ActivityScheduleFailedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduledEventDetails

func (ActivityScheduledEventDetails) GoString

GoString returns the string representation

func (*ActivityScheduledEventDetails) SetHeartbeatInSeconds

SetHeartbeatInSeconds sets the HeartbeatInSeconds field's value.

func (*ActivityScheduledEventDetails) SetInput

SetInput sets the Input field's value.

func (*ActivityScheduledEventDetails) SetResource

SetResource sets the Resource field's value.

func (*ActivityScheduledEventDetails) SetTimeoutInSeconds

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (ActivityScheduledEventDetails) String

String returns the string representation

type ActivityStartedEventDetails

type ActivityStartedEventDetails struct {

	// The name of the worker that the task was assigned to. These names are provided
	// by the workers when calling GetActivityTask.
	WorkerName *string `locationName:"workerName" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityStartedEventDetails

func (ActivityStartedEventDetails) GoString

func (s ActivityStartedEventDetails) GoString() string

GoString returns the string representation

func (*ActivityStartedEventDetails) SetWorkerName

SetWorkerName sets the WorkerName field's value.

func (ActivityStartedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivitySucceededEventDetails

func (ActivitySucceededEventDetails) GoString

GoString returns the string representation

func (*ActivitySucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (ActivitySucceededEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityTimedOutEventDetails

func (ActivityTimedOutEventDetails) GoString

func (s ActivityTimedOutEventDetails) GoString() string

GoString returns the string representation

func (*ActivityTimedOutEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ActivityTimedOutEventDetails) SetError

SetError sets the Error field's value.

func (ActivityTimedOutEventDetails) String

String returns the string representation

type CreateActivityInput

type CreateActivityInput struct {

	// The name of the activity to create. This name must be unique for your AWS
	// account and region.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityInput

func (CreateActivityInput) GoString

func (s CreateActivityInput) GoString() string

GoString returns the string representation

func (*CreateActivityInput) SetName

SetName sets the Name field's value.

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 was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityOutput

func (CreateActivityOutput) GoString

func (s CreateActivityOutput) GoString() string

GoString returns the string representation

func (*CreateActivityOutput) SetActivityArn

func (s *CreateActivityOutput) SetActivityArn(v string) *CreateActivityOutput

SetActivityArn sets the ActivityArn field's value.

func (*CreateActivityOutput) SetCreationDate

func (s *CreateActivityOutput) SetCreationDate(v time.Time) *CreateActivityOutput

SetCreationDate sets the CreationDate field's value.

func (CreateActivityOutput) String

func (s CreateActivityOutput) String() string

String returns the string representation

type CreateStateMachineInput

type CreateStateMachineInput struct {

	// The Amazon States Language definition of the state machine.
	//
	// Definition is a required field
	Definition *string `locationName:"definition" min:"1" type:"string" required:"true"`

	// The name of the state machine. This name must be unique for your AWS account
	// and region.
	//
	// 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"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineInput

func (CreateStateMachineInput) GoString

func (s CreateStateMachineInput) GoString() string

GoString returns the string representation

func (*CreateStateMachineInput) SetDefinition

SetDefinition sets the Definition field's value.

func (*CreateStateMachineInput) SetName

SetName sets the Name field's value.

func (*CreateStateMachineInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

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 was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineOutput

func (CreateStateMachineOutput) GoString

func (s CreateStateMachineOutput) GoString() string

GoString returns the string representation

func (*CreateStateMachineOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*CreateStateMachineOutput) SetStateMachineArn

func (s *CreateStateMachineOutput) SetStateMachineArn(v string) *CreateStateMachineOutput

SetStateMachineArn sets the StateMachineArn field's value.

func (CreateStateMachineOutput) String

func (s CreateStateMachineOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityInput

func (DeleteActivityInput) GoString

func (s DeleteActivityInput) GoString() string

GoString returns the string representation

func (*DeleteActivityInput) SetActivityArn

func (s *DeleteActivityInput) SetActivityArn(v string) *DeleteActivityInput

SetActivityArn sets the ActivityArn field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityOutput

func (DeleteActivityOutput) GoString

func (s DeleteActivityOutput) GoString() string

GoString returns the string representation

func (DeleteActivityOutput) String

func (s DeleteActivityOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineInput

func (DeleteStateMachineInput) GoString

func (s DeleteStateMachineInput) GoString() string

GoString returns the string representation

func (*DeleteStateMachineInput) SetStateMachineArn

func (s *DeleteStateMachineInput) SetStateMachineArn(v string) *DeleteStateMachineInput

SetStateMachineArn sets the StateMachineArn field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineOutput

func (DeleteStateMachineOutput) GoString

func (s DeleteStateMachineOutput) GoString() string

GoString returns the string representation

func (DeleteStateMachineOutput) String

func (s DeleteStateMachineOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityInput

func (DescribeActivityInput) GoString

func (s DescribeActivityInput) GoString() string

GoString returns the string representation

func (*DescribeActivityInput) SetActivityArn

func (s *DescribeActivityInput) SetActivityArn(v string) *DescribeActivityInput

SetActivityArn sets the ActivityArn field's value.

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 was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The name of the activity.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityOutput

func (DescribeActivityOutput) GoString

func (s DescribeActivityOutput) GoString() string

GoString returns the string representation

func (*DescribeActivityOutput) SetActivityArn

SetActivityArn sets the ActivityArn field's value.

func (*DescribeActivityOutput) SetCreationDate

func (s *DescribeActivityOutput) SetCreationDate(v time.Time) *DescribeActivityOutput

SetCreationDate sets the CreationDate field's value.

func (*DescribeActivityOutput) SetName

SetName sets the Name field's value.

func (DescribeActivityOutput) String

func (s DescribeActivityOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionInput

func (DescribeExecutionInput) GoString

func (s DescribeExecutionInput) GoString() string

GoString returns the string representation

func (*DescribeExecutionInput) SetExecutionArn

func (s *DescribeExecutionInput) SetExecutionArn(v string) *DescribeExecutionInput

SetExecutionArn sets the ExecutionArn field's value.

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 JSON input data of the execution.
	//
	// Input is a required field
	Input *string `locationName:"input" type:"string" required:"true"`

	// The name of the execution.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The JSON output data of the execution.
	Output *string `locationName:"output" type:"string"`

	// The date the execution was started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"unix" 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 *string `locationName:"status" type:"string" required:"true" enum:"ExecutionStatus"`

	// If the execution has already ended, the date the execution stopped.
	StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionOutput

func (DescribeExecutionOutput) GoString

func (s DescribeExecutionOutput) GoString() string

GoString returns the string representation

func (*DescribeExecutionOutput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (*DescribeExecutionOutput) SetInput

SetInput sets the Input field's value.

func (*DescribeExecutionOutput) SetName

SetName sets the Name field's value.

func (*DescribeExecutionOutput) SetOutput

SetOutput sets the Output field's value.

func (*DescribeExecutionOutput) SetStartDate

SetStartDate sets the StartDate field's value.

func (*DescribeExecutionOutput) SetStateMachineArn

func (s *DescribeExecutionOutput) SetStateMachineArn(v string) *DescribeExecutionOutput

SetStateMachineArn sets the StateMachineArn field's value.

func (*DescribeExecutionOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribeExecutionOutput) SetStopDate

SetStopDate sets the StopDate field's value.

func (DescribeExecutionOutput) String

func (s DescribeExecutionOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineInput

func (DescribeStateMachineInput) GoString

func (s DescribeStateMachineInput) GoString() string

GoString returns the string representation

func (*DescribeStateMachineInput) SetStateMachineArn

SetStateMachineArn sets the StateMachineArn field's value.

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 was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The Amazon States Language definition of the state machine.
	//
	// Definition is a required field
	Definition *string `locationName:"definition" min:"1" type:"string" required:"true"`

	// The name of the state machine.
	//
	// 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 for executing this state
	// machine.
	//
	// 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 *string `locationName:"status" type:"string" enum:"StateMachineStatus"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput

func (DescribeStateMachineOutput) GoString

func (s DescribeStateMachineOutput) GoString() string

GoString returns the string representation

func (*DescribeStateMachineOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeStateMachineOutput) SetDefinition

SetDefinition sets the Definition field's value.

func (*DescribeStateMachineOutput) SetName

SetName sets the Name field's value.

func (*DescribeStateMachineOutput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DescribeStateMachineOutput) SetStateMachineArn

SetStateMachineArn sets the StateMachineArn field's value.

func (*DescribeStateMachineOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeStateMachineOutput) String

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionAbortedEventDetails

func (ExecutionAbortedEventDetails) GoString

func (s ExecutionAbortedEventDetails) GoString() string

GoString returns the string representation

func (*ExecutionAbortedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ExecutionAbortedEventDetails) SetError

SetError sets the Error field's value.

func (ExecutionAbortedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionFailedEventDetails

func (ExecutionFailedEventDetails) GoString

func (s ExecutionFailedEventDetails) GoString() string

GoString returns the string representation

func (*ExecutionFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ExecutionFailedEventDetails) SetError

SetError sets the Error field's value.

func (ExecutionFailedEventDetails) 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.
	//
	// 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" timestampFormat:"unix" 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 *string `locationName:"status" type:"string" required:"true" enum:"ExecutionStatus"`

	// If the execution already ended, the date the execution stopped.
	StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionListItem

func (ExecutionListItem) GoString

func (s ExecutionListItem) GoString() string

GoString returns the string representation

func (*ExecutionListItem) SetExecutionArn

func (s *ExecutionListItem) SetExecutionArn(v string) *ExecutionListItem

SetExecutionArn sets the ExecutionArn field's value.

func (*ExecutionListItem) SetName

SetName sets the Name field's value.

func (*ExecutionListItem) SetStartDate

func (s *ExecutionListItem) SetStartDate(v time.Time) *ExecutionListItem

SetStartDate sets the StartDate field's value.

func (*ExecutionListItem) SetStateMachineArn

func (s *ExecutionListItem) SetStateMachineArn(v string) *ExecutionListItem

SetStateMachineArn sets the StateMachineArn field's value.

func (*ExecutionListItem) SetStatus

func (s *ExecutionListItem) SetStatus(v string) *ExecutionListItem

SetStatus sets the Status field's value.

func (*ExecutionListItem) SetStopDate

func (s *ExecutionListItem) SetStopDate(v time.Time) *ExecutionListItem

SetStopDate sets the StopDate field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionStartedEventDetails

func (ExecutionStartedEventDetails) GoString

func (s ExecutionStartedEventDetails) GoString() string

GoString returns the string representation

func (*ExecutionStartedEventDetails) SetInput

SetInput sets the Input field's value.

func (*ExecutionStartedEventDetails) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (ExecutionStartedEventDetails) String

String returns the string representation

type ExecutionSucceededEventDetails

type ExecutionSucceededEventDetails struct {

	// The JSON data output by the execution.
	Output *string `locationName:"output" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionSucceededEventDetails

func (ExecutionSucceededEventDetails) GoString

GoString returns the string representation

func (*ExecutionSucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (ExecutionSucceededEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionTimedOutEventDetails

func (ExecutionTimedOutEventDetails) GoString

GoString returns the string representation

func (*ExecutionTimedOutEventDetails) SetCause

SetCause sets the Cause field's value.

func (*ExecutionTimedOutEventDetails) SetError

SetError sets the Error field's value.

func (ExecutionTimedOutEventDetails) String

String returns the string representation

type GetActivityTaskInput

type GetActivityTaskInput struct {

	// The Amazon Resource Name (ARN) of the activity to retrieve tasks from.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`

	// An arbitrary name may be provided in order to identify the worker that the
	// task is assigned to. This name will be used when it is logged in the execution
	// history.
	WorkerName *string `locationName:"workerName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskInput

func (GetActivityTaskInput) GoString

func (s GetActivityTaskInput) GoString() string

GoString returns the string representation

func (*GetActivityTaskInput) SetActivityArn

func (s *GetActivityTaskInput) SetActivityArn(v string) *GetActivityTaskInput

SetActivityArn sets the ActivityArn field's value.

func (*GetActivityTaskInput) SetWorkerName

func (s *GetActivityTaskInput) SetWorkerName(v string) *GetActivityTaskInput

SetWorkerName sets the WorkerName field's value.

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskOutput

func (GetActivityTaskOutput) GoString

func (s GetActivityTaskOutput) GoString() string

GoString returns the string representation

func (*GetActivityTaskOutput) SetInput

SetInput sets the Input field's value.

func (*GetActivityTaskOutput) SetTaskToken

SetTaskToken sets the TaskToken field's value.

func (GetActivityTaskOutput) String

func (s GetActivityTaskOutput) String() string

String returns the string representation

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 will be returned per call. nextToken can
	// be used to obtain further pages of results. The default is 100 and the maximum
	// allowed page size is 1000.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If a nextToken was returned by a previous call, there are more results available.
	// To retrieve the next page of results, make the call again using the returned
	// token in nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryInput

func (GetExecutionHistoryInput) GoString

func (s GetExecutionHistoryInput) GoString() string

GoString returns the string representation

func (*GetExecutionHistoryInput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (*GetExecutionHistoryInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetExecutionHistoryInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetExecutionHistoryInput) SetReverseOrder

SetReverseOrder sets the ReverseOrder field's value.

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 a nextToken is returned, there are more results available. To retrieve
	// the next page of results, make the call again using the returned token in
	// nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryOutput

func (GetExecutionHistoryOutput) GoString

func (s GetExecutionHistoryOutput) GoString() string

GoString returns the string representation

func (*GetExecutionHistoryOutput) SetEvents

SetEvents sets the Events field's value.

func (*GetExecutionHistoryOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (GetExecutionHistoryOutput) String

func (s GetExecutionHistoryOutput) String() string

String returns the string representation

type HistoryEvent

type HistoryEvent struct {
	ActivityFailedEventDetails *ActivityFailedEventDetails `locationName:"activityFailedEventDetails" type:"structure"`

	ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails `locationName:"activityScheduleFailedEventDetails" type:"structure"`

	ActivityScheduledEventDetails *ActivityScheduledEventDetails `locationName:"activityScheduledEventDetails" type:"structure"`

	ActivityStartedEventDetails *ActivityStartedEventDetails `locationName:"activityStartedEventDetails" type:"structure"`

	ActivitySucceededEventDetails *ActivitySucceededEventDetails `locationName:"activitySucceededEventDetails" type:"structure"`

	ActivityTimedOutEventDetails *ActivityTimedOutEventDetails `locationName:"activityTimedOutEventDetails" type:"structure"`

	ExecutionAbortedEventDetails *ExecutionAbortedEventDetails `locationName:"executionAbortedEventDetails" type:"structure"`

	ExecutionFailedEventDetails *ExecutionFailedEventDetails `locationName:"executionFailedEventDetails" type:"structure"`

	ExecutionStartedEventDetails *ExecutionStartedEventDetails `locationName:"executionStartedEventDetails" type:"structure"`

	ExecutionSucceededEventDetails *ExecutionSucceededEventDetails `locationName:"executionSucceededEventDetails" type:"structure"`

	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"`

	LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails `locationName:"lambdaFunctionFailedEventDetails" type:"structure"`

	LambdaFunctionScheduleFailedEventDetails *LambdaFunctionScheduleFailedEventDetails `locationName:"lambdaFunctionScheduleFailedEventDetails" type:"structure"`

	LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails `locationName:"lambdaFunctionScheduledEventDetails" type:"structure"`

	LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails `locationName:"lambdaFunctionStartFailedEventDetails" type:"structure"`

	LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails `locationName:"lambdaFunctionSucceededEventDetails" type:"structure"`

	LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails `locationName:"lambdaFunctionTimedOutEventDetails" type:"structure"`

	// The id of the previous event.
	PreviousEventId *int64 `locationName:"previousEventId" type:"long"`

	StateEnteredEventDetails *StateEnteredEventDetails `locationName:"stateEnteredEventDetails" type:"structure"`

	StateExitedEventDetails *StateExitedEventDetails `locationName:"stateExitedEventDetails" type:"structure"`

	// The date the event occured.
	//
	// Timestamp is a required field
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The type of the event.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"HistoryEventType"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEvent

func (HistoryEvent) GoString

func (s HistoryEvent) GoString() string

GoString returns the string representation

func (*HistoryEvent) SetActivityFailedEventDetails

func (s *HistoryEvent) SetActivityFailedEventDetails(v *ActivityFailedEventDetails) *HistoryEvent

SetActivityFailedEventDetails sets the ActivityFailedEventDetails field's value.

func (*HistoryEvent) SetActivityScheduleFailedEventDetails

func (s *HistoryEvent) SetActivityScheduleFailedEventDetails(v *ActivityScheduleFailedEventDetails) *HistoryEvent

SetActivityScheduleFailedEventDetails sets the ActivityScheduleFailedEventDetails field's value.

func (*HistoryEvent) SetActivityScheduledEventDetails

func (s *HistoryEvent) SetActivityScheduledEventDetails(v *ActivityScheduledEventDetails) *HistoryEvent

SetActivityScheduledEventDetails sets the ActivityScheduledEventDetails field's value.

func (*HistoryEvent) SetActivityStartedEventDetails

func (s *HistoryEvent) SetActivityStartedEventDetails(v *ActivityStartedEventDetails) *HistoryEvent

SetActivityStartedEventDetails sets the ActivityStartedEventDetails field's value.

func (*HistoryEvent) SetActivitySucceededEventDetails

func (s *HistoryEvent) SetActivitySucceededEventDetails(v *ActivitySucceededEventDetails) *HistoryEvent

SetActivitySucceededEventDetails sets the ActivitySucceededEventDetails field's value.

func (*HistoryEvent) SetActivityTimedOutEventDetails

func (s *HistoryEvent) SetActivityTimedOutEventDetails(v *ActivityTimedOutEventDetails) *HistoryEvent

SetActivityTimedOutEventDetails sets the ActivityTimedOutEventDetails field's value.

func (*HistoryEvent) SetExecutionAbortedEventDetails

func (s *HistoryEvent) SetExecutionAbortedEventDetails(v *ExecutionAbortedEventDetails) *HistoryEvent

SetExecutionAbortedEventDetails sets the ExecutionAbortedEventDetails field's value.

func (*HistoryEvent) SetExecutionFailedEventDetails

func (s *HistoryEvent) SetExecutionFailedEventDetails(v *ExecutionFailedEventDetails) *HistoryEvent

SetExecutionFailedEventDetails sets the ExecutionFailedEventDetails field's value.

func (*HistoryEvent) SetExecutionStartedEventDetails

func (s *HistoryEvent) SetExecutionStartedEventDetails(v *ExecutionStartedEventDetails) *HistoryEvent

SetExecutionStartedEventDetails sets the ExecutionStartedEventDetails field's value.

func (*HistoryEvent) SetExecutionSucceededEventDetails

func (s *HistoryEvent) SetExecutionSucceededEventDetails(v *ExecutionSucceededEventDetails) *HistoryEvent

SetExecutionSucceededEventDetails sets the ExecutionSucceededEventDetails field's value.

func (*HistoryEvent) SetExecutionTimedOutEventDetails

func (s *HistoryEvent) SetExecutionTimedOutEventDetails(v *ExecutionTimedOutEventDetails) *HistoryEvent

SetExecutionTimedOutEventDetails sets the ExecutionTimedOutEventDetails field's value.

func (*HistoryEvent) SetId

func (s *HistoryEvent) SetId(v int64) *HistoryEvent

SetId sets the Id field's value.

func (*HistoryEvent) SetLambdaFunctionFailedEventDetails

func (s *HistoryEvent) SetLambdaFunctionFailedEventDetails(v *LambdaFunctionFailedEventDetails) *HistoryEvent

SetLambdaFunctionFailedEventDetails sets the LambdaFunctionFailedEventDetails field's value.

func (*HistoryEvent) SetLambdaFunctionScheduleFailedEventDetails

func (s *HistoryEvent) SetLambdaFunctionScheduleFailedEventDetails(v *LambdaFunctionScheduleFailedEventDetails) *HistoryEvent

SetLambdaFunctionScheduleFailedEventDetails sets the LambdaFunctionScheduleFailedEventDetails field's value.

func (*HistoryEvent) SetLambdaFunctionScheduledEventDetails

func (s *HistoryEvent) SetLambdaFunctionScheduledEventDetails(v *LambdaFunctionScheduledEventDetails) *HistoryEvent

SetLambdaFunctionScheduledEventDetails sets the LambdaFunctionScheduledEventDetails field's value.

func (*HistoryEvent) SetLambdaFunctionStartFailedEventDetails

func (s *HistoryEvent) SetLambdaFunctionStartFailedEventDetails(v *LambdaFunctionStartFailedEventDetails) *HistoryEvent

SetLambdaFunctionStartFailedEventDetails sets the LambdaFunctionStartFailedEventDetails field's value.

func (*HistoryEvent) SetLambdaFunctionSucceededEventDetails

func (s *HistoryEvent) SetLambdaFunctionSucceededEventDetails(v *LambdaFunctionSucceededEventDetails) *HistoryEvent

SetLambdaFunctionSucceededEventDetails sets the LambdaFunctionSucceededEventDetails field's value.

func (*HistoryEvent) SetLambdaFunctionTimedOutEventDetails

func (s *HistoryEvent) SetLambdaFunctionTimedOutEventDetails(v *LambdaFunctionTimedOutEventDetails) *HistoryEvent

SetLambdaFunctionTimedOutEventDetails sets the LambdaFunctionTimedOutEventDetails field's value.

func (*HistoryEvent) SetPreviousEventId

func (s *HistoryEvent) SetPreviousEventId(v int64) *HistoryEvent

SetPreviousEventId sets the PreviousEventId field's value.

func (*HistoryEvent) SetStateEnteredEventDetails

func (s *HistoryEvent) SetStateEnteredEventDetails(v *StateEnteredEventDetails) *HistoryEvent

SetStateEnteredEventDetails sets the StateEnteredEventDetails field's value.

func (*HistoryEvent) SetStateExitedEventDetails

func (s *HistoryEvent) SetStateExitedEventDetails(v *StateExitedEventDetails) *HistoryEvent

SetStateExitedEventDetails sets the StateExitedEventDetails field's value.

func (*HistoryEvent) SetTimestamp

func (s *HistoryEvent) SetTimestamp(v time.Time) *HistoryEvent

SetTimestamp sets the Timestamp field's value.

func (*HistoryEvent) SetType

func (s *HistoryEvent) SetType(v string) *HistoryEvent

SetType sets the Type field's value.

func (HistoryEvent) String

func (s HistoryEvent) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionFailedEventDetails

func (LambdaFunctionFailedEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*LambdaFunctionFailedEventDetails) SetError

SetError sets the Error field's value.

func (LambdaFunctionFailedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduleFailedEventDetails

func (LambdaFunctionScheduleFailedEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionScheduleFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*LambdaFunctionScheduleFailedEventDetails) SetError

SetError sets the Error field's value.

func (LambdaFunctionScheduleFailedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduledEventDetails

func (LambdaFunctionScheduledEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionScheduledEventDetails) SetInput

SetInput sets the Input field's value.

func (*LambdaFunctionScheduledEventDetails) SetResource

SetResource sets the Resource field's value.

func (*LambdaFunctionScheduledEventDetails) SetTimeoutInSeconds

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (LambdaFunctionScheduledEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionStartFailedEventDetails

func (LambdaFunctionStartFailedEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionStartFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*LambdaFunctionStartFailedEventDetails) SetError

SetError sets the Error field's value.

func (LambdaFunctionStartFailedEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionSucceededEventDetails

func (LambdaFunctionSucceededEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionSucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (LambdaFunctionSucceededEventDetails) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionTimedOutEventDetails

func (LambdaFunctionTimedOutEventDetails) GoString

GoString returns the string representation

func (*LambdaFunctionTimedOutEventDetails) SetCause

SetCause sets the Cause field's value.

func (*LambdaFunctionTimedOutEventDetails) SetError

SetError sets the Error field's value.

func (LambdaFunctionTimedOutEventDetails) String

String returns the string representation

type ListActivitiesInput

type ListActivitiesInput struct {

	// The maximum number of results that will be returned per call. nextToken can
	// be used to obtain further pages of results. The default is 100 and the maximum
	// allowed page size is 1000.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If a nextToken was returned by a previous call, there are more results available.
	// To retrieve the next page of results, make the call again using the returned
	// token in nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesInput

func (ListActivitiesInput) GoString

func (s ListActivitiesInput) GoString() string

GoString returns the string representation

func (*ListActivitiesInput) SetMaxResults

func (s *ListActivitiesInput) SetMaxResults(v int64) *ListActivitiesInput

SetMaxResults sets the MaxResults field's value.

func (*ListActivitiesInput) SetNextToken

func (s *ListActivitiesInput) SetNextToken(v string) *ListActivitiesInput

SetNextToken sets the NextToken field's value.

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 a nextToken is returned, there are more results available. To retrieve
	// the next page of results, make the call again using the returned token in
	// nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesOutput

func (ListActivitiesOutput) GoString

func (s ListActivitiesOutput) GoString() string

GoString returns the string representation

func (*ListActivitiesOutput) SetActivities

SetActivities sets the Activities field's value.

func (*ListActivitiesOutput) SetNextToken

func (s *ListActivitiesOutput) SetNextToken(v string) *ListActivitiesOutput

SetNextToken sets the NextToken field's value.

func (ListActivitiesOutput) String

func (s ListActivitiesOutput) String() string

String returns the string representation

type ListExecutionsInput

type ListExecutionsInput struct {

	// The maximum number of results that will be returned per call. nextToken can
	// be used to obtain further pages of results. The default is 100 and the maximum
	// allowed page size is 1000.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If a nextToken was returned by a previous call, there are more results available.
	// To retrieve the next page of results, make the call again using the returned
	// token in nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine whose executions will
	// be 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 *string `locationName:"statusFilter" type:"string" enum:"ExecutionStatus"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsInput

func (ListExecutionsInput) GoString

func (s ListExecutionsInput) GoString() string

GoString returns the string representation

func (*ListExecutionsInput) SetMaxResults

func (s *ListExecutionsInput) SetMaxResults(v int64) *ListExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListExecutionsInput) SetNextToken

func (s *ListExecutionsInput) SetNextToken(v string) *ListExecutionsInput

SetNextToken sets the NextToken field's value.

func (*ListExecutionsInput) SetStateMachineArn

func (s *ListExecutionsInput) SetStateMachineArn(v string) *ListExecutionsInput

SetStateMachineArn sets the StateMachineArn field's value.

func (*ListExecutionsInput) SetStatusFilter

func (s *ListExecutionsInput) SetStatusFilter(v string) *ListExecutionsInput

SetStatusFilter sets the StatusFilter field's value.

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 a nextToken is returned, there are more results available. To retrieve
	// the next page of results, make the call again using the returned token in
	// nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsOutput

func (ListExecutionsOutput) GoString

func (s ListExecutionsOutput) GoString() string

GoString returns the string representation

func (*ListExecutionsOutput) SetExecutions

SetExecutions sets the Executions field's value.

func (*ListExecutionsOutput) SetNextToken

func (s *ListExecutionsOutput) SetNextToken(v string) *ListExecutionsOutput

SetNextToken sets the NextToken field's value.

func (ListExecutionsOutput) String

func (s ListExecutionsOutput) String() string

String returns the string representation

type ListStateMachinesInput

type ListStateMachinesInput struct {

	// The maximum number of results that will be returned per call. nextToken can
	// be used to obtain further pages of results. The default is 100 and the maximum
	// allowed page size is 1000.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If a nextToken was returned by a previous call, there are more results available.
	// To retrieve the next page of results, make the call again using the returned
	// token in nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesInput

func (ListStateMachinesInput) GoString

func (s ListStateMachinesInput) GoString() string

GoString returns the string representation

func (*ListStateMachinesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListStateMachinesInput) SetNextToken

SetNextToken sets the NextToken field's value.

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 a nextToken is returned, there are more results available. To retrieve
	// the next page of results, make the call again using the returned token in
	// nextToken. Keep all other arguments unchanged.
	//
	// The configured maxResults determines how many results can be returned in
	// a single call.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesOutput

func (ListStateMachinesOutput) GoString

func (s ListStateMachinesOutput) GoString() string

GoString returns the string representation

func (*ListStateMachinesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListStateMachinesOutput) SetStateMachines

SetStateMachines sets the StateMachines field's value.

func (ListStateMachinesOutput) String

func (s ListStateMachinesOutput) String() string

String returns the string representation

type SFN

type SFN struct {
	*client.Client
}

AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.

Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SFN

New creates a new instance of the SFN client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a SFN client from just a session.
svc := sfn.New(mySession)

// Create a SFN client with additional configuration
svc := sfn.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SFN) CreateActivity

func (c *SFN) CreateActivity(input *CreateActivityInput) (*CreateActivityOutput, error)

CreateActivity API operation for AWS Step Functions.

Creates an activity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation CreateActivity for usage and error information.

Returned Error Codes:

  • ActivityLimitExceeded The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

  • InvalidName The provided name is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivity

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.CreateActivityInput{
		Name: aws.String("Name"), // Required
	}
	resp, err := svc.CreateActivity(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) CreateActivityRequest

func (c *SFN) CreateActivityRequest(input *CreateActivityInput) (req *request.Request, output *CreateActivityOutput)

CreateActivityRequest generates a "aws/request.Request" representing the client's request for the CreateActivity operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateActivity for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateActivity method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateActivityRequest method.
req, resp := client.CreateActivityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivity

func (*SFN) CreateStateMachine

func (c *SFN) CreateStateMachine(input *CreateStateMachineInput) (*CreateStateMachineOutput, error)

CreateStateMachine API operation for AWS Step Functions.

Creates a state machine.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation CreateStateMachine for usage and error information.

Returned Error Codes:

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

  • InvalidDefinition The provided Amazon States Language definition is invalid.

  • InvalidName The provided name is invalid.

  • StateMachineAlreadyExists A state machine with the same name but a different definition or role ARN already exists.

  • StateMachineDeleting The specified state machine is being deleted.

  • StateMachineLimitExceeded The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachine

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.CreateStateMachineInput{
		Definition: aws.String("Definition"), // Required
		Name:       aws.String("Name"),       // Required
		RoleArn:    aws.String("Arn"),        // Required
	}
	resp, err := svc.CreateStateMachine(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) CreateStateMachineRequest

func (c *SFN) CreateStateMachineRequest(input *CreateStateMachineInput) (req *request.Request, output *CreateStateMachineOutput)

CreateStateMachineRequest generates a "aws/request.Request" representing the client's request for the CreateStateMachine operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateStateMachine for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStateMachine method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateStateMachineRequest method.
req, resp := client.CreateStateMachineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachine

func (*SFN) DeleteActivity

func (c *SFN) DeleteActivity(input *DeleteActivityInput) (*DeleteActivityOutput, error)

DeleteActivity API operation for AWS Step Functions.

Deletes an activity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation DeleteActivity for usage and error information.

Returned Error Codes:

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.DeleteActivityInput{
		ActivityArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DeleteActivity(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) DeleteActivityRequest

func (c *SFN) DeleteActivityRequest(input *DeleteActivityInput) (req *request.Request, output *DeleteActivityOutput)

DeleteActivityRequest generates a "aws/request.Request" representing the client's request for the DeleteActivity operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteActivity for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteActivity method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteActivityRequest method.
req, resp := client.DeleteActivityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity

func (*SFN) DeleteStateMachine

func (c *SFN) DeleteStateMachine(input *DeleteStateMachineInput) (*DeleteStateMachineOutput, error)

DeleteStateMachine 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 delete process.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation DeleteStateMachine for usage and error information.

Returned Error Codes:

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.DeleteStateMachineInput{
		StateMachineArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DeleteStateMachine(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) DeleteStateMachineRequest

func (c *SFN) DeleteStateMachineRequest(input *DeleteStateMachineInput) (req *request.Request, output *DeleteStateMachineOutput)

DeleteStateMachineRequest generates a "aws/request.Request" representing the client's request for the DeleteStateMachine operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteStateMachine for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStateMachine method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteStateMachineRequest method.
req, resp := client.DeleteStateMachineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine

func (*SFN) DescribeActivity

func (c *SFN) DescribeActivity(input *DescribeActivityInput) (*DescribeActivityOutput, error)

DescribeActivity API operation for AWS Step Functions.

Describes an activity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation DescribeActivity for usage and error information.

Returned Error Codes:

  • ActivityDoesNotExist The specified activity does not exist.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.DescribeActivityInput{
		ActivityArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DescribeActivity(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) DescribeActivityRequest

func (c *SFN) DescribeActivityRequest(input *DescribeActivityInput) (req *request.Request, output *DescribeActivityOutput)

DescribeActivityRequest generates a "aws/request.Request" representing the client's request for the DescribeActivity operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeActivity for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeActivity method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeActivityRequest method.
req, resp := client.DescribeActivityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity

func (*SFN) DescribeExecution

func (c *SFN) DescribeExecution(input *DescribeExecutionInput) (*DescribeExecutionOutput, error)

DescribeExecution API operation for AWS Step Functions.

Describes an execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation DescribeExecution for usage and error information.

Returned Error Codes:

  • ExecutionDoesNotExist The specified execution does not exist.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.DescribeExecutionInput{
		ExecutionArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DescribeExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) DescribeExecutionRequest

func (c *SFN) DescribeExecutionRequest(input *DescribeExecutionInput) (req *request.Request, output *DescribeExecutionOutput)

DescribeExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeExecution operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeExecutionRequest method.
req, resp := client.DescribeExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution

func (*SFN) DescribeStateMachine

func (c *SFN) DescribeStateMachine(input *DescribeStateMachineInput) (*DescribeStateMachineOutput, error)

DescribeStateMachine API operation for AWS Step Functions.

Describes a state machine.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation DescribeStateMachine for usage and error information.

Returned Error Codes:

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

  • StateMachineDoesNotExist The specified state machine does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.DescribeStateMachineInput{
		StateMachineArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DescribeStateMachine(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) DescribeStateMachineRequest

func (c *SFN) DescribeStateMachineRequest(input *DescribeStateMachineInput) (req *request.Request, output *DescribeStateMachineOutput)

DescribeStateMachineRequest generates a "aws/request.Request" representing the client's request for the DescribeStateMachine operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeStateMachine for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStateMachine method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeStateMachineRequest method.
req, resp := client.DescribeStateMachineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine

func (*SFN) GetActivityTask

func (c *SFN) GetActivityTask(input *GetActivityTaskInput) (*GetActivityTaskOutput, error)

GetActivityTask API operation for AWS Step Functions.

Used by workers to retrieve a task (with the specified activity ARN) 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 will return an empty result, that is, the taskToken returned is an empty 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation GetActivityTask for usage and error information.

Returned Error Codes:

  • ActivityDoesNotExist The specified activity does not exist.

  • ActivityWorkerLimitExceeded The maximum number of workers concurrently polling for activity tasks has been reached.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.GetActivityTaskInput{
		ActivityArn: aws.String("Arn"), // Required
		WorkerName:  aws.String("Name"),
	}
	resp, err := svc.GetActivityTask(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) GetActivityTaskRequest

func (c *SFN) GetActivityTaskRequest(input *GetActivityTaskInput) (req *request.Request, output *GetActivityTaskOutput)

GetActivityTaskRequest generates a "aws/request.Request" representing the client's request for the GetActivityTask operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetActivityTask for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetActivityTask method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetActivityTaskRequest method.
req, resp := client.GetActivityTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask

func (*SFN) GetExecutionHistory

func (c *SFN) GetExecutionHistory(input *GetExecutionHistoryInput) (*GetExecutionHistoryOutput, error)

GetExecutionHistory 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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation GetExecutionHistory for usage and error information.

Returned Error Codes:

  • ExecutionDoesNotExist The specified execution does not exist.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

  • InvalidToken The provided token is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.GetExecutionHistoryInput{
		ExecutionArn: aws.String("Arn"), // Required
		MaxResults:   aws.Int64(1),
		NextToken:    aws.String("PageToken"),
		ReverseOrder: aws.Bool(true),
	}
	resp, err := svc.GetExecutionHistory(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) GetExecutionHistoryPages

func (c *SFN) GetExecutionHistoryPages(input *GetExecutionHistoryInput, fn func(p *GetExecutionHistoryOutput, lastPage bool) (shouldContinue bool)) error

GetExecutionHistoryPages iterates over the pages of a GetExecutionHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetExecutionHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetExecutionHistory operation.
pageNum := 0
err := client.GetExecutionHistoryPages(params,
    func(page *GetExecutionHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) GetExecutionHistoryRequest

func (c *SFN) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) (req *request.Request, output *GetExecutionHistoryOutput)

GetExecutionHistoryRequest generates a "aws/request.Request" representing the client's request for the GetExecutionHistory operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetExecutionHistory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetExecutionHistory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the GetExecutionHistoryRequest method.
req, resp := client.GetExecutionHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory

func (*SFN) ListActivities

func (c *SFN) ListActivities(input *ListActivitiesInput) (*ListActivitiesOutput, error)

ListActivities API operation for AWS Step Functions.

Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation ListActivities for usage and error information.

Returned Error Codes:

  • InvalidToken The provided token is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.ListActivitiesInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("PageToken"),
	}
	resp, err := svc.ListActivities(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) ListActivitiesPages

func (c *SFN) ListActivitiesPages(input *ListActivitiesInput, fn func(p *ListActivitiesOutput, lastPage bool) (shouldContinue bool)) error

ListActivitiesPages iterates over the pages of a ListActivities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListActivities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListActivities operation.
pageNum := 0
err := client.ListActivitiesPages(params,
    func(page *ListActivitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListActivitiesRequest

func (c *SFN) ListActivitiesRequest(input *ListActivitiesInput) (req *request.Request, output *ListActivitiesOutput)

ListActivitiesRequest generates a "aws/request.Request" representing the client's request for the ListActivities operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListActivities for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListActivities method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListActivitiesRequest method.
req, resp := client.ListActivitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities

func (*SFN) ListExecutions

func (c *SFN) ListExecutions(input *ListExecutionsInput) (*ListExecutionsOutput, error)

ListExecutions API operation for AWS Step Functions.

Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation ListExecutions for usage and error information.

Returned Error Codes:

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

  • InvalidToken The provided token is invalid.

  • StateMachineDoesNotExist The specified state machine does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.ListExecutionsInput{
		StateMachineArn: aws.String("Arn"), // Required
		MaxResults:      aws.Int64(1),
		NextToken:       aws.String("PageToken"),
		StatusFilter:    aws.String("ExecutionStatus"),
	}
	resp, err := svc.ListExecutions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) ListExecutionsPages

func (c *SFN) ListExecutionsPages(input *ListExecutionsInput, fn func(p *ListExecutionsOutput, lastPage bool) (shouldContinue bool)) error

ListExecutionsPages iterates over the pages of a ListExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListExecutions operation.
pageNum := 0
err := client.ListExecutionsPages(params,
    func(page *ListExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListExecutionsRequest

func (c *SFN) ListExecutionsRequest(input *ListExecutionsInput) (req *request.Request, output *ListExecutionsOutput)

ListExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListExecutions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListExecutions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListExecutions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListExecutionsRequest method.
req, resp := client.ListExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions

func (*SFN) ListStateMachines

func (c *SFN) ListStateMachines(input *ListStateMachinesInput) (*ListStateMachinesOutput, error)

ListStateMachines API operation for AWS Step Functions.

Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation ListStateMachines for usage and error information.

Returned Error Codes:

  • InvalidToken The provided token is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.ListStateMachinesInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("PageToken"),
	}
	resp, err := svc.ListStateMachines(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) ListStateMachinesPages

func (c *SFN) ListStateMachinesPages(input *ListStateMachinesInput, fn func(p *ListStateMachinesOutput, lastPage bool) (shouldContinue bool)) error

ListStateMachinesPages iterates over the pages of a ListStateMachines operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStateMachines method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListStateMachines operation.
pageNum := 0
err := client.ListStateMachinesPages(params,
    func(page *ListStateMachinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListStateMachinesRequest

func (c *SFN) ListStateMachinesRequest(input *ListStateMachinesInput) (req *request.Request, output *ListStateMachinesOutput)

ListStateMachinesRequest generates a "aws/request.Request" representing the client's request for the ListStateMachines operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListStateMachines for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListStateMachines method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListStateMachinesRequest method.
req, resp := client.ListStateMachinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines

func (*SFN) SendTaskFailure

func (c *SFN) SendTaskFailure(input *SendTaskFailureInput) (*SendTaskFailureOutput, error)

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailure

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.SendTaskFailureInput{
		TaskToken: aws.String("TaskToken"), // Required
		Cause:     aws.String("Cause"),
		Error:     aws.String("Error"),
	}
	resp, err := svc.SendTaskFailure(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) SendTaskFailureRequest

func (c *SFN) SendTaskFailureRequest(input *SendTaskFailureInput) (req *request.Request, output *SendTaskFailureOutput)

SendTaskFailureRequest generates a "aws/request.Request" representing the client's request for the SendTaskFailure operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SendTaskFailure for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendTaskFailure method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SendTaskFailureRequest method.
req, resp := client.SendTaskFailureRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailure

func (*SFN) SendTaskHeartbeat

func (c *SFN) SendTaskHeartbeat(input *SendTaskHeartbeatInput) (*SendTaskHeartbeatOutput, error)

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeat

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.SendTaskHeartbeatInput{
		TaskToken: aws.String("TaskToken"), // Required
	}
	resp, err := svc.SendTaskHeartbeat(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) SendTaskHeartbeatRequest

func (c *SFN) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) (req *request.Request, output *SendTaskHeartbeatOutput)

SendTaskHeartbeatRequest generates a "aws/request.Request" representing the client's request for the SendTaskHeartbeat operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SendTaskHeartbeat for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendTaskHeartbeat method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SendTaskHeartbeatRequest method.
req, resp := client.SendTaskHeartbeatRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeat

func (*SFN) SendTaskSuccess

func (c *SFN) SendTaskSuccess(input *SendTaskSuccessInput) (*SendTaskSuccessOutput, error)

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccess

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.SendTaskSuccessInput{
		Output:    aws.String("Data"),      // Required
		TaskToken: aws.String("TaskToken"), // Required
	}
	resp, err := svc.SendTaskSuccess(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) SendTaskSuccessRequest

func (c *SFN) SendTaskSuccessRequest(input *SendTaskSuccessInput) (req *request.Request, output *SendTaskSuccessOutput)

SendTaskSuccessRequest generates a "aws/request.Request" representing the client's request for the SendTaskSuccess operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SendTaskSuccess for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendTaskSuccess method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the SendTaskSuccessRequest method.
req, resp := client.SendTaskSuccessRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccess

func (*SFN) StartExecution

func (c *SFN) StartExecution(input *StartExecutionInput) (*StartExecutionOutput, error)

StartExecution API operation for AWS Step Functions.

Starts a state machine execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation StartExecution for usage and error information.

Returned Error Codes:

  • ExecutionLimitExceeded The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

  • ExecutionAlreadyExists An execution with the same name already exists.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

  • InvalidExecutionInput The provided JSON input data is invalid.

  • InvalidName The provided name is invalid.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • StateMachineDeleting The specified state machine is being deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.StartExecutionInput{
		StateMachineArn: aws.String("Arn"), // Required
		Input:           aws.String("Data"),
		Name:            aws.String("Name"),
	}
	resp, err := svc.StartExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) StartExecutionRequest

func (c *SFN) StartExecutionRequest(input *StartExecutionInput) (req *request.Request, output *StartExecutionOutput)

StartExecutionRequest generates a "aws/request.Request" representing the client's request for the StartExecution operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StartExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the StartExecutionRequest method.
req, resp := client.StartExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution

func (*SFN) StopExecution

func (c *SFN) StopExecution(input *StopExecutionInput) (*StopExecutionOutput, error)

StopExecution API operation for AWS Step Functions.

Stops an execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Step Functions's API operation StopExecution for usage and error information.

Returned Error Codes:

  • ExecutionDoesNotExist The specified execution does not exist.

  • InvalidArn The provided Amazon Resource Name (ARN) is invalid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sfn"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sfn.New(sess)

	params := &sfn.StopExecutionInput{
		ExecutionArn: aws.String("Arn"), // Required
		Cause:        aws.String("Cause"),
		Error:        aws.String("Error"),
	}
	resp, err := svc.StopExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*SFN) StopExecutionRequest

func (c *SFN) StopExecutionRequest(input *StopExecutionInput) (req *request.Request, output *StopExecutionOutput)

StopExecutionRequest generates a "aws/request.Request" representing the client's request for the StopExecution operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StopExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the StopExecutionRequest method.
req, resp := client.StopExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution

type SendTaskFailureInput

type SendTaskFailureInput struct {

	// A more detailed explanation of the cause of the failure.
	Cause *string `locationName:"cause" type:"string"`

	// An arbitrary error code that identifies the cause of the failure.
	Error *string `locationName:"error" type:"string"`

	// The token that represents this task. Task tokens are generated by the service
	// when the tasks are assigned to a worker (see GetActivityTask::taskToken).
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureInput

func (SendTaskFailureInput) GoString

func (s SendTaskFailureInput) GoString() string

GoString returns the string representation

func (*SendTaskFailureInput) SetCause

SetCause sets the Cause field's value.

func (*SendTaskFailureInput) SetError

SetError sets the Error field's value.

func (*SendTaskFailureInput) SetTaskToken

func (s *SendTaskFailureInput) SetTaskToken(v string) *SendTaskFailureInput

SetTaskToken sets the TaskToken field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureOutput

func (SendTaskFailureOutput) GoString

func (s SendTaskFailureOutput) GoString() string

GoString returns the string representation

func (SendTaskFailureOutput) String

func (s SendTaskFailureOutput) String() string

String returns the string representation

type SendTaskHeartbeatInput

type SendTaskHeartbeatInput struct {

	// The token that represents this task. Task tokens are generated by the service
	// when the tasks are assigned to a worker (see GetActivityTask::taskToken).
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatInput

func (SendTaskHeartbeatInput) GoString

func (s SendTaskHeartbeatInput) GoString() string

GoString returns the string representation

func (*SendTaskHeartbeatInput) SetTaskToken

SetTaskToken sets the TaskToken field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatOutput

func (SendTaskHeartbeatOutput) GoString

func (s SendTaskHeartbeatOutput) GoString() string

GoString returns the string representation

func (SendTaskHeartbeatOutput) String

func (s SendTaskHeartbeatOutput) String() string

String returns the string representation

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 the service
	// when the tasks are assigned to a worker (see GetActivityTask::taskToken).
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessInput

func (SendTaskSuccessInput) GoString

func (s SendTaskSuccessInput) GoString() string

GoString returns the string representation

func (*SendTaskSuccessInput) SetOutput

SetOutput sets the Output field's value.

func (*SendTaskSuccessInput) SetTaskToken

func (s *SendTaskSuccessInput) SetTaskToken(v string) *SendTaskSuccessInput

SetTaskToken sets the TaskToken field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessOutput

func (SendTaskSuccessOutput) GoString

func (s SendTaskSuccessOutput) GoString() string

GoString returns the string representation

func (SendTaskSuccessOutput) String

func (s SendTaskSuccessOutput) String() string

String returns the string representation

type StartExecutionInput

type StartExecutionInput struct {

	// The JSON input data for the execution.
	Input *string `locationName:"input" type:"string"`

	// The name of the execution. This name must be unique for your AWS account
	// and region.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput

func (StartExecutionInput) GoString

func (s StartExecutionInput) GoString() string

GoString returns the string representation

func (*StartExecutionInput) SetInput

SetInput sets the Input field's value.

func (*StartExecutionInput) SetName

SetName sets the Name field's value.

func (*StartExecutionInput) SetStateMachineArn

func (s *StartExecutionInput) SetStateMachineArn(v string) *StartExecutionInput

SetStateMachineArn sets the StateMachineArn field's value.

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 was started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionOutput

func (StartExecutionOutput) GoString

func (s StartExecutionOutput) GoString() string

GoString returns the string representation

func (*StartExecutionOutput) SetExecutionArn

func (s *StartExecutionOutput) SetExecutionArn(v string) *StartExecutionOutput

SetExecutionArn sets the ExecutionArn field's value.

func (*StartExecutionOutput) SetStartDate

func (s *StartExecutionOutput) SetStartDate(v time.Time) *StartExecutionOutput

SetStartDate sets the StartDate field's value.

func (StartExecutionOutput) String

func (s StartExecutionOutput) String() string

String returns the string representation

type StateEnteredEventDetails

type StateEnteredEventDetails struct {

	// The JSON input data to 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateEnteredEventDetails

func (StateEnteredEventDetails) GoString

func (s StateEnteredEventDetails) GoString() string

GoString returns the string representation

func (*StateEnteredEventDetails) SetInput

SetInput sets the Input field's value.

func (*StateEnteredEventDetails) SetName

SetName sets the Name field's value.

func (StateEnteredEventDetails) String

func (s StateEnteredEventDetails) String() string

String returns the string representation

type StateExitedEventDetails

type StateExitedEventDetails struct {

	// The name of the state.
	//
	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateExitedEventDetails

func (StateExitedEventDetails) GoString

func (s StateExitedEventDetails) GoString() string

GoString returns the string representation

func (*StateExitedEventDetails) SetName

SetName sets the Name field's value.

func (*StateExitedEventDetails) SetOutput

SetOutput sets the Output field's value.

func (StateExitedEventDetails) String

func (s StateExitedEventDetails) String() string

String returns the string representation

type StateMachineListItem

type StateMachineListItem struct {

	// The date the state machine was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The name of the state machine.
	//
	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateMachineListItem

func (StateMachineListItem) GoString

func (s StateMachineListItem) GoString() string

GoString returns the string representation

func (*StateMachineListItem) SetCreationDate

func (s *StateMachineListItem) SetCreationDate(v time.Time) *StateMachineListItem

SetCreationDate sets the CreationDate field's value.

func (*StateMachineListItem) SetName

SetName sets the Name field's value.

func (*StateMachineListItem) SetStateMachineArn

func (s *StateMachineListItem) SetStateMachineArn(v string) *StateMachineListItem

SetStateMachineArn sets the StateMachineArn field's value.

func (StateMachineListItem) String

func (s StateMachineListItem) String() string

String returns the string representation

type StopExecutionInput

type StopExecutionInput struct {

	// A more detailed explanation of the cause of the termination.
	Cause *string `locationName:"cause" type:"string"`

	// An arbitrary error code that identifies the cause of the termination.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionInput

func (StopExecutionInput) GoString

func (s StopExecutionInput) GoString() string

GoString returns the string representation

func (*StopExecutionInput) SetCause

SetCause sets the Cause field's value.

func (*StopExecutionInput) SetError

SetError sets the Error field's value.

func (*StopExecutionInput) SetExecutionArn

func (s *StopExecutionInput) SetExecutionArn(v string) *StopExecutionInput

SetExecutionArn sets the ExecutionArn field's value.

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 was stopped.
	//
	// StopDate is a required field
	StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionOutput

func (StopExecutionOutput) GoString

func (s StopExecutionOutput) GoString() string

GoString returns the string representation

func (*StopExecutionOutput) SetStopDate

func (s *StopExecutionOutput) SetStopDate(v time.Time) *StopExecutionOutput

SetStopDate sets the StopDate field's value.

func (StopExecutionOutput) String

func (s StopExecutionOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package sfniface provides an interface to enable mocking the AWS Step Functions service client for testing your code.
Package sfniface provides an interface to enable mocking the AWS Step Functions service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL