sfn

package
v1.42.9 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package sfn provides the client and types for making API requests to AWS Step Functions.

Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide (https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) .

See https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23 for more information on this service.

See sfn package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sfn/

Using the Client

To contact AWS Step Functions with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Step Functions client SFN for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sfn/#New

Index

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"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// HistoryEventTypeMapIterationAborted is a HistoryEventType enum value
	HistoryEventTypeMapIterationAborted = "MapIterationAborted"

	// HistoryEventTypeMapIterationFailed is a HistoryEventType enum value
	HistoryEventTypeMapIterationFailed = "MapIterationFailed"

	// HistoryEventTypeMapIterationStarted is a HistoryEventType enum value
	HistoryEventTypeMapIterationStarted = "MapIterationStarted"

	// HistoryEventTypeMapIterationSucceeded is a HistoryEventType enum value
	HistoryEventTypeMapIterationSucceeded = "MapIterationSucceeded"

	// HistoryEventTypeMapStateAborted is a HistoryEventType enum value
	HistoryEventTypeMapStateAborted = "MapStateAborted"

	// HistoryEventTypeMapStateEntered is a HistoryEventType enum value
	HistoryEventTypeMapStateEntered = "MapStateEntered"

	// HistoryEventTypeMapStateExited is a HistoryEventType enum value
	HistoryEventTypeMapStateExited = "MapStateExited"

	// HistoryEventTypeMapStateFailed is a HistoryEventType enum value
	HistoryEventTypeMapStateFailed = "MapStateFailed"

	// HistoryEventTypeMapStateStarted is a HistoryEventType enum value
	HistoryEventTypeMapStateStarted = "MapStateStarted"

	// HistoryEventTypeMapStateSucceeded is a HistoryEventType enum value
	HistoryEventTypeMapStateSucceeded = "MapStateSucceeded"

	// HistoryEventTypeParallelStateAborted is a HistoryEventType enum value
	HistoryEventTypeParallelStateAborted = "ParallelStateAborted"

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

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

	// HistoryEventTypeParallelStateFailed is a HistoryEventType enum value
	HistoryEventTypeParallelStateFailed = "ParallelStateFailed"

	// HistoryEventTypeParallelStateStarted is a HistoryEventType enum value
	HistoryEventTypeParallelStateStarted = "ParallelStateStarted"

	// HistoryEventTypeParallelStateSucceeded is a HistoryEventType enum value
	HistoryEventTypeParallelStateSucceeded = "ParallelStateSucceeded"

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

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

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

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

	// HistoryEventTypeTaskFailed is a HistoryEventType enum value
	HistoryEventTypeTaskFailed = "TaskFailed"

	// HistoryEventTypeTaskScheduled is a HistoryEventType enum value
	HistoryEventTypeTaskScheduled = "TaskScheduled"

	// HistoryEventTypeTaskStarted is a HistoryEventType enum value
	HistoryEventTypeTaskStarted = "TaskStarted"

	// HistoryEventTypeTaskStartFailed is a HistoryEventType enum value
	HistoryEventTypeTaskStartFailed = "TaskStartFailed"

	// HistoryEventTypeTaskStateAborted is a HistoryEventType enum value
	HistoryEventTypeTaskStateAborted = "TaskStateAborted"

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

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

	// HistoryEventTypeTaskSubmitFailed is a HistoryEventType enum value
	HistoryEventTypeTaskSubmitFailed = "TaskSubmitFailed"

	// HistoryEventTypeTaskSubmitted is a HistoryEventType enum value
	HistoryEventTypeTaskSubmitted = "TaskSubmitted"

	// HistoryEventTypeTaskSucceeded is a HistoryEventType enum value
	HistoryEventTypeTaskSucceeded = "TaskSucceeded"

	// HistoryEventTypeTaskTimedOut is a HistoryEventType enum value
	HistoryEventTypeTaskTimedOut = "TaskTimedOut"

	// HistoryEventTypeWaitStateAborted is a HistoryEventType enum value
	HistoryEventTypeWaitStateAborted = "WaitStateAborted"

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

	// HistoryEventTypeWaitStateExited is a HistoryEventType enum value
	HistoryEventTypeWaitStateExited = "WaitStateExited"

	// HistoryEventTypeMapRunAborted is a HistoryEventType enum value
	HistoryEventTypeMapRunAborted = "MapRunAborted"

	// HistoryEventTypeMapRunFailed is a HistoryEventType enum value
	HistoryEventTypeMapRunFailed = "MapRunFailed"

	// HistoryEventTypeMapRunStarted is a HistoryEventType enum value
	HistoryEventTypeMapRunStarted = "MapRunStarted"

	// HistoryEventTypeMapRunSucceeded is a HistoryEventType enum value
	HistoryEventTypeMapRunSucceeded = "MapRunSucceeded"
)
View Source
const (
	// LogLevelAll is a LogLevel enum value
	LogLevelAll = "ALL"

	// LogLevelError is a LogLevel enum value
	LogLevelError = "ERROR"

	// LogLevelFatal is a LogLevel enum value
	LogLevelFatal = "FATAL"

	// LogLevelOff is a LogLevel enum value
	LogLevelOff = "OFF"
)
View Source
const (
	// MapRunStatusRunning is a MapRunStatus enum value
	MapRunStatusRunning = "RUNNING"

	// MapRunStatusSucceeded is a MapRunStatus enum value
	MapRunStatusSucceeded = "SUCCEEDED"

	// MapRunStatusFailed is a MapRunStatus enum value
	MapRunStatusFailed = "FAILED"

	// MapRunStatusAborted is a MapRunStatus enum value
	MapRunStatusAborted = "ABORTED"
)
View Source
const (
	// StateMachineStatusActive is a StateMachineStatus enum value
	StateMachineStatusActive = "ACTIVE"

	// StateMachineStatusDeleting is a StateMachineStatus enum value
	StateMachineStatusDeleting = "DELETING"
)
View Source
const (
	// StateMachineTypeStandard is a StateMachineType enum value
	StateMachineTypeStandard = "STANDARD"

	// StateMachineTypeExpress is a StateMachineType enum value
	StateMachineTypeExpress = "EXPRESS"
)
View Source
const (
	// SyncExecutionStatusSucceeded is a SyncExecutionStatus enum value
	SyncExecutionStatusSucceeded = "SUCCEEDED"

	// SyncExecutionStatusFailed is a SyncExecutionStatus enum value
	SyncExecutionStatusFailed = "FAILED"

	// SyncExecutionStatusTimedOut is a SyncExecutionStatus enum value
	SyncExecutionStatusTimedOut = "TIMED_OUT"
)
View Source
const (
	// ValidationExceptionReasonApiDoesNotSupportLabeledArns is a ValidationExceptionReason enum value
	ValidationExceptionReasonApiDoesNotSupportLabeledArns = "API_DOES_NOT_SUPPORT_LABELED_ARNS"

	// ValidationExceptionReasonMissingRequiredParameter is a ValidationExceptionReason enum value
	ValidationExceptionReasonMissingRequiredParameter = "MISSING_REQUIRED_PARAMETER"

	// ValidationExceptionReasonCannotUpdateCompletedMapRun is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotUpdateCompletedMapRun = "CANNOT_UPDATE_COMPLETED_MAP_RUN"

	// ValidationExceptionReasonInvalidRoutingConfiguration is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidRoutingConfiguration = "INVALID_ROUTING_CONFIGURATION"
)
View Source
const (

	// ErrCodeActivityDoesNotExist for service response error code
	// "ActivityDoesNotExist".
	//
	// The specified activity does not exist.
	ErrCodeActivityDoesNotExist = "ActivityDoesNotExist"

	// ErrCodeActivityLimitExceeded for service response error code
	// "ActivityLimitExceeded".
	//
	// The maximum number of activities has been reached. Existing activities must
	// be deleted before a new activity can be created.
	ErrCodeActivityLimitExceeded = "ActivityLimitExceeded"

	// ErrCodeActivityWorkerLimitExceeded for service response error code
	// "ActivityWorkerLimitExceeded".
	//
	// The maximum number of workers concurrently polling for activity tasks has
	// been reached.
	ErrCodeActivityWorkerLimitExceeded = "ActivityWorkerLimitExceeded"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Updating or deleting a resource can cause an inconsistent state. This error
	// occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
	// or UpdateStateMachine with the publish parameter set to true.
	//
	// HTTP Status Code: 409
	ErrCodeConflictException = "ConflictException"

	// ErrCodeExecutionAlreadyExists for service response error code
	// "ExecutionAlreadyExists".
	//
	// The execution has the same name as another execution (but a different input).
	//
	// Executions with the same name and input are considered idempotent.
	ErrCodeExecutionAlreadyExists = "ExecutionAlreadyExists"

	// ErrCodeExecutionDoesNotExist for service response error code
	// "ExecutionDoesNotExist".
	//
	// The specified execution does not exist.
	ErrCodeExecutionDoesNotExist = "ExecutionDoesNotExist"

	// ErrCodeExecutionLimitExceeded for service response error code
	// "ExecutionLimitExceeded".
	//
	// The maximum number of running executions has been reached. Running executions
	// must end or be stopped before a new execution can be started.
	ErrCodeExecutionLimitExceeded = "ExecutionLimitExceeded"

	// ErrCodeInvalidArn for service response error code
	// "InvalidArn".
	//
	// The provided Amazon Resource Name (ARN) is not valid.
	ErrCodeInvalidArn = "InvalidArn"

	// ErrCodeInvalidDefinition for service response error code
	// "InvalidDefinition".
	//
	// The provided Amazon States Language definition is not valid.
	ErrCodeInvalidDefinition = "InvalidDefinition"

	// ErrCodeInvalidExecutionInput for service response error code
	// "InvalidExecutionInput".
	//
	// The provided JSON input data is not valid.
	ErrCodeInvalidExecutionInput = "InvalidExecutionInput"

	// ErrCodeInvalidLoggingConfiguration for service response error code
	// "InvalidLoggingConfiguration".
	ErrCodeInvalidLoggingConfiguration = "InvalidLoggingConfiguration"

	// ErrCodeInvalidName for service response error code
	// "InvalidName".
	//
	// The provided name is not valid.
	ErrCodeInvalidName = "InvalidName"

	// ErrCodeInvalidOutput for service response error code
	// "InvalidOutput".
	//
	// The provided JSON output data is not valid.
	ErrCodeInvalidOutput = "InvalidOutput"

	// ErrCodeInvalidToken for service response error code
	// "InvalidToken".
	//
	// The provided token is not valid.
	ErrCodeInvalidToken = "InvalidToken"

	// ErrCodeInvalidTracingConfiguration for service response error code
	// "InvalidTracingConfiguration".
	//
	// Your tracingConfiguration key does not match, or enabled has not been set
	// to true or false.
	ErrCodeInvalidTracingConfiguration = "InvalidTracingConfiguration"

	// ErrCodeMissingRequiredParameter for service response error code
	// "MissingRequiredParameter".
	//
	// Request is missing a required parameter. This error occurs if both definition
	// and roleArn are not specified.
	ErrCodeMissingRequiredParameter = "MissingRequiredParameter"

	// ErrCodeResourceNotFound for service response error code
	// "ResourceNotFound".
	//
	// Could not find the referenced resource.
	ErrCodeResourceNotFound = "ResourceNotFound"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request would cause a service quota to be exceeded.
	//
	// HTTP Status Code: 402
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeStateMachineAlreadyExists for service response error code
	// "StateMachineAlreadyExists".
	//
	// A state machine with the same name but a different definition or role ARN
	// already exists.
	ErrCodeStateMachineAlreadyExists = "StateMachineAlreadyExists"

	// ErrCodeStateMachineDeleting for service response error code
	// "StateMachineDeleting".
	//
	// The specified state machine is being deleted.
	ErrCodeStateMachineDeleting = "StateMachineDeleting"

	// ErrCodeStateMachineDoesNotExist for service response error code
	// "StateMachineDoesNotExist".
	//
	// The specified state machine does not exist.
	ErrCodeStateMachineDoesNotExist = "StateMachineDoesNotExist"

	// ErrCodeStateMachineLimitExceeded for service response error code
	// "StateMachineLimitExceeded".
	//
	// The maximum number of state machines has been reached. Existing state machines
	// must be deleted before a new state machine can be created.
	ErrCodeStateMachineLimitExceeded = "StateMachineLimitExceeded"

	// ErrCodeStateMachineTypeNotSupported for service response error code
	// "StateMachineTypeNotSupported".
	ErrCodeStateMachineTypeNotSupported = "StateMachineTypeNotSupported"

	// ErrCodeTaskDoesNotExist for service response error code
	// "TaskDoesNotExist".
	ErrCodeTaskDoesNotExist = "TaskDoesNotExist"

	// ErrCodeTaskTimedOut for service response error code
	// "TaskTimedOut".
	ErrCodeTaskTimedOut = "TaskTimedOut"

	// ErrCodeTooManyTags for service response error code
	// "TooManyTags".
	//
	// You've exceeded the number of tags allowed for a resource. See the Limits
	// Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html)
	// in the Step Functions Developer Guide.
	ErrCodeTooManyTags = "TooManyTags"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input does not satisfy the constraints specified by an Amazon Web Services
	// service.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "states"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "SFN"       // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ExecutionStatus_Values

func ExecutionStatus_Values() []string

ExecutionStatus_Values returns all elements of the ExecutionStatus enum

func HistoryEventType_Values

func HistoryEventType_Values() []string

HistoryEventType_Values returns all elements of the HistoryEventType enum

func LogLevel_Values

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func MapRunStatus_Values added in v1.42.9

func MapRunStatus_Values() []string

MapRunStatus_Values returns all elements of the MapRunStatus enum

func StateMachineStatus_Values

func StateMachineStatus_Values() []string

StateMachineStatus_Values returns all elements of the StateMachineStatus enum

func StateMachineType_Values

func StateMachineType_Values() []string

StateMachineType_Values returns all elements of the StateMachineType enum

func SyncExecutionStatus_Values

func SyncExecutionStatus_Values() []string

SyncExecutionStatus_Values returns all elements of the SyncExecutionStatus enum

func ValidationExceptionReason_Values added in v1.42.9

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type ActivityDoesNotExist

type ActivityDoesNotExist struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified activity does not exist.

func (*ActivityDoesNotExist) Code

func (s *ActivityDoesNotExist) Code() string

Code returns the exception type name.

func (*ActivityDoesNotExist) Error

func (s *ActivityDoesNotExist) Error() string

func (ActivityDoesNotExist) GoString

func (s ActivityDoesNotExist) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivityDoesNotExist) Message

func (s *ActivityDoesNotExist) Message() string

Message returns the exception's message.

func (*ActivityDoesNotExist) OrigErr

func (s *ActivityDoesNotExist) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ActivityDoesNotExist) RequestID

func (s *ActivityDoesNotExist) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ActivityDoesNotExist) StatusCode

func (s *ActivityDoesNotExist) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ActivityDoesNotExist) String

func (s ActivityDoesNotExist) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityFailedEventDetails

type ActivityFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about an activity that failed during an execution.

func (ActivityFailedEventDetails) GoString

func (s ActivityFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityLimitExceeded

type ActivityLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ActivityLimitExceeded) Code

func (s *ActivityLimitExceeded) Code() string

Code returns the exception type name.

func (*ActivityLimitExceeded) Error

func (s *ActivityLimitExceeded) Error() string

func (ActivityLimitExceeded) GoString

func (s ActivityLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivityLimitExceeded) Message

func (s *ActivityLimitExceeded) Message() string

Message returns the exception's message.

func (*ActivityLimitExceeded) OrigErr

func (s *ActivityLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ActivityLimitExceeded) RequestID

func (s *ActivityLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ActivityLimitExceeded) StatusCode

func (s *ActivityLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ActivityLimitExceeded) String

func (s ActivityLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityListItem

type ActivityListItem struct {

	// The Amazon Resource Name (ARN) that identifies the activity.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`

	// The date the activity is created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The name of the activity.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an activity.

func (ActivityListItem) GoString

func (s ActivityListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityScheduleFailedEventDetails

type ActivityScheduleFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityScheduleFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityScheduleFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about an activity schedule failure that occurred during an execution.

func (ActivityScheduleFailedEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Length constraints apply to the
	// payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityScheduledEventDetails's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Contains details about the input for an execution history event.
	InputDetails *HistoryEventExecutionDataDetails `locationName:"inputDetails" type:"structure"`

	// The Amazon Resource Name (ARN) of the scheduled activity.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The maximum allowed duration of the activity task.
	TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"`
	// contains filtered or unexported fields
}

Contains details about an activity scheduled during an execution.

func (ActivityScheduledEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivityScheduledEventDetails) SetHeartbeatInSeconds

SetHeartbeatInSeconds sets the HeartbeatInSeconds field's value.

func (*ActivityScheduledEventDetails) SetInput

SetInput sets the Input field's value.

func (*ActivityScheduledEventDetails) SetInputDetails

SetInputDetails sets the InputDetails 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityStartedEventDetails

type ActivityStartedEventDetails struct {

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

Contains details about the start of an activity during an execution.

func (ActivityStartedEventDetails) GoString

func (s ActivityStartedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivityStartedEventDetails) SetWorkerName

SetWorkerName sets the WorkerName field's value.

func (ActivityStartedEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivitySucceededEventDetails

type ActivitySucceededEventDetails struct {

	// The JSON data output by the activity task. Length constraints apply to the
	// payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivitySucceededEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about an activity that successfully terminated during an execution.

func (ActivitySucceededEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivitySucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*ActivitySucceededEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (ActivitySucceededEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityTimedOutEventDetails

type ActivityTimedOutEventDetails struct {

	// A more detailed explanation of the cause of the timeout.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityTimedOutEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivityTimedOutEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about an activity timeout that occurred during an execution.

func (ActivityTimedOutEventDetails) GoString

func (s ActivityTimedOutEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivityWorkerLimitExceeded

type ActivityWorkerLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ActivityWorkerLimitExceeded) Code

Code returns the exception type name.

func (*ActivityWorkerLimitExceeded) Error

func (ActivityWorkerLimitExceeded) GoString

func (s ActivityWorkerLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivityWorkerLimitExceeded) Message

func (s *ActivityWorkerLimitExceeded) Message() string

Message returns the exception's message.

func (*ActivityWorkerLimitExceeded) OrigErr

func (s *ActivityWorkerLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ActivityWorkerLimitExceeded) RequestID

func (s *ActivityWorkerLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ActivityWorkerLimitExceeded) StatusCode

func (s *ActivityWorkerLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ActivityWorkerLimitExceeded) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BillingDetails

type BillingDetails struct {

	// Billed duration of your workflow, in milliseconds.
	BilledDurationInMilliseconds *int64 `locationName:"billedDurationInMilliseconds" type:"long"`

	// Billed memory consumption of your workflow, in MB.
	BilledMemoryUsedInMB *int64 `locationName:"billedMemoryUsedInMB" type:"long"`
	// contains filtered or unexported fields
}

An object that describes workflow billing details.

func (BillingDetails) GoString

func (s BillingDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BillingDetails) SetBilledDurationInMilliseconds

func (s *BillingDetails) SetBilledDurationInMilliseconds(v int64) *BillingDetails

SetBilledDurationInMilliseconds sets the BilledDurationInMilliseconds field's value.

func (*BillingDetails) SetBilledMemoryUsedInMB

func (s *BillingDetails) SetBilledMemoryUsedInMB(v int64) *BillingDetails

SetBilledMemoryUsedInMB sets the BilledMemoryUsedInMB field's value.

func (BillingDetails) String

func (s BillingDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchEventsExecutionDataDetails

type CloudWatchEventsExecutionDataDetails struct {

	// Indicates whether input or output was included in the response. Always true
	// for API calls.
	Included *bool `locationName:"included" type:"boolean"`
	// contains filtered or unexported fields
}

Provides details about execution input or output.

func (CloudWatchEventsExecutionDataDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchEventsExecutionDataDetails) SetIncluded

SetIncluded sets the Included field's value.

func (CloudWatchEventsExecutionDataDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchLogsLogGroup

type CloudWatchLogsLogGroup struct {

	// The ARN of the the CloudWatch log group to which you want your logs emitted
	// to. The ARN must end with :*
	LogGroupArn *string `locationName:"logGroupArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CloudWatchLogsLogGroup) GoString

func (s CloudWatchLogsLogGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsLogGroup) SetLogGroupArn

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudWatchLogsLogGroup) String

func (s CloudWatchLogsLogGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsLogGroup) Validate

func (s *CloudWatchLogsLogGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException added in v1.42.9

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

func (*ConflictException) Code added in v1.42.9

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.42.9

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.42.9

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.42.9

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.42.9

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.42.9

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.42.9

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.42.9

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateActivityInput

type CreateActivityInput struct {

	// The name of the activity to create. This name must be unique for your Amazon
	// Web Services account and region for 90 days. For more information, see Limits
	// Related to State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions)
	// in the Step Functions Developer Guide.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The list of tags to add to a resource.
	//
	// An array of key-value pairs. For more information, see Using Cost Allocation
	// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
	// in the Amazon Web Services Billing and Cost Management User Guide, and Controlling
	// Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
	//
	// Tags may only contain Unicode letters, digits, white space, or these symbols:
	// _ . : / = + - @.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateActivityInput) GoString

func (s CreateActivityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateActivityInput) SetName

SetName sets the Name field's value.

func (*CreateActivityInput) SetTags

func (s *CreateActivityInput) SetTags(v []*Tag) *CreateActivityInput

SetTags sets the Tags field's value.

func (CreateActivityInput) String

func (s CreateActivityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateActivityInput) Validate

func (s *CreateActivityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateActivityOutput

type CreateActivityOutput struct {

	// The Amazon Resource Name (ARN) that identifies the created activity.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`

	// The date the activity is created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (CreateActivityOutput) GoString

func (s CreateActivityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStateMachineAliasInput added in v1.42.9

type CreateStateMachineAliasInput struct {

	// A description for the state machine alias.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateStateMachineAliasInput's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The name of the state machine alias.
	//
	// To avoid conflict with version ARNs, don't use an integer in the name of
	// the alias.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The routing configuration of a state machine alias. The routing configuration
	// shifts execution traffic between two state machine versions. routingConfiguration
	// contains an array of RoutingConfig objects that specify up to two state machine
	// versions. Step Functions then randomly choses which version to run an execution
	// with based on the weight assigned to each RoutingConfig.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*RoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStateMachineAliasInput) GoString added in v1.42.9

func (s CreateStateMachineAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStateMachineAliasInput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*CreateStateMachineAliasInput) SetName added in v1.42.9

SetName sets the Name field's value.

func (*CreateStateMachineAliasInput) SetRoutingConfiguration added in v1.42.9

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (CreateStateMachineAliasInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStateMachineAliasInput) Validate added in v1.42.9

func (s *CreateStateMachineAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStateMachineAliasOutput added in v1.42.9

type CreateStateMachineAliasOutput struct {

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

	// The Amazon Resource Name (ARN) that identifies the created state machine
	// alias.
	//
	// StateMachineAliasArn is a required field
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStateMachineAliasOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStateMachineAliasOutput) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*CreateStateMachineAliasOutput) SetStateMachineAliasArn added in v1.42.9

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (CreateStateMachineAliasOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStateMachineInput

type CreateStateMachineInput struct {

	// The Amazon States Language definition of the state machine. See Amazon States
	// Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).
	//
	// Definition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateStateMachineInput's
	// String and GoString methods.
	//
	// Definition is a required field
	Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"`

	// Defines what execution history events are logged and where they are logged.
	//
	// By default, the level is set to OFF. For more information see Log Levels
	// (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html)
	// in the Step Functions User Guide.
	LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"`

	// The name of the state machine.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Set to true to publish the first version of the state machine during creation.
	// The default is false.
	Publish *bool `locationName:"publish" type:"boolean"`

	// The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// Tags to be added when creating a state machine.
	//
	// An array of key-value pairs. For more information, see Using Cost Allocation
	// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
	// in the Amazon Web Services Billing and Cost Management User Guide, and Controlling
	// Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
	//
	// Tags may only contain Unicode letters, digits, white space, or these symbols:
	// _ . : / = + - @.
	Tags []*Tag `locationName:"tags" type:"list"`

	// Selects whether X-Ray tracing is enabled.
	TracingConfiguration *TracingConfiguration `locationName:"tracingConfiguration" type:"structure"`

	// Determines whether a Standard or Express state machine is created. The default
	// is STANDARD. You cannot update the type of a state machine once it has been
	// created.
	Type *string `locationName:"type" type:"string" enum:"StateMachineType"`

	// Sets description about the state machine version. You can only set the description
	// if the publish parameter is set to true. Otherwise, if you set versionDescription,
	// but publish to false, this API action throws ValidationException.
	//
	// VersionDescription is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateStateMachineInput's
	// String and GoString methods.
	VersionDescription *string `locationName:"versionDescription" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateStateMachineInput) GoString

func (s CreateStateMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStateMachineInput) SetDefinition

SetDefinition sets the Definition field's value.

func (*CreateStateMachineInput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*CreateStateMachineInput) SetName

SetName sets the Name field's value.

func (*CreateStateMachineInput) SetPublish added in v1.42.9

SetPublish sets the Publish field's value.

func (*CreateStateMachineInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateStateMachineInput) SetTags

SetTags sets the Tags field's value.

func (*CreateStateMachineInput) SetTracingConfiguration

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*CreateStateMachineInput) SetType

SetType sets the Type field's value.

func (*CreateStateMachineInput) SetVersionDescription added in v1.42.9

func (s *CreateStateMachineInput) SetVersionDescription(v string) *CreateStateMachineInput

SetVersionDescription sets the VersionDescription field's value.

func (CreateStateMachineInput) String

func (s CreateStateMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStateMachineInput) Validate

func (s *CreateStateMachineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStateMachineOutput

type CreateStateMachineOutput struct {

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

	// The Amazon Resource Name (ARN) that identifies the created state machine.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that identifies the created state machine
	// version. If you do not set the publish parameter to true, this field returns
	// null value.
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateStateMachineOutput) GoString

func (s CreateStateMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetStateMachineVersionArn added in v1.42.9

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

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (CreateStateMachineOutput) String

func (s CreateStateMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteActivityInput

type DeleteActivityInput struct {

	// The Amazon Resource Name (ARN) of the activity to delete.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteActivityInput) GoString

func (s DeleteActivityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteActivityInput) Validate

func (s *DeleteActivityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteActivityOutput

type DeleteActivityOutput struct {
	// contains filtered or unexported fields
}

func (DeleteActivityOutput) GoString

func (s DeleteActivityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteActivityOutput) String

func (s DeleteActivityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStateMachineAliasInput added in v1.42.9

type DeleteStateMachineAliasInput struct {

	// The Amazon Resource Name (ARN) of the state machine alias to delete.
	//
	// StateMachineAliasArn is a required field
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStateMachineAliasInput) GoString added in v1.42.9

func (s DeleteStateMachineAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStateMachineAliasInput) SetStateMachineAliasArn added in v1.42.9

func (s *DeleteStateMachineAliasInput) SetStateMachineAliasArn(v string) *DeleteStateMachineAliasInput

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (DeleteStateMachineAliasInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStateMachineAliasInput) Validate added in v1.42.9

func (s *DeleteStateMachineAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStateMachineAliasOutput added in v1.42.9

type DeleteStateMachineAliasOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStateMachineAliasOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStateMachineAliasOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStateMachineInput

type DeleteStateMachineInput struct {

	// The Amazon Resource Name (ARN) of the state machine to delete.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStateMachineInput) GoString

func (s DeleteStateMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStateMachineInput) Validate

func (s *DeleteStateMachineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStateMachineOutput

type DeleteStateMachineOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStateMachineOutput) GoString

func (s DeleteStateMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStateMachineOutput) String

func (s DeleteStateMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStateMachineVersionInput added in v1.42.9

type DeleteStateMachineVersionInput struct {

	// The Amazon Resource Name (ARN) of the state machine version to delete.
	//
	// StateMachineVersionArn is a required field
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStateMachineVersionInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStateMachineVersionInput) SetStateMachineVersionArn added in v1.42.9

func (s *DeleteStateMachineVersionInput) SetStateMachineVersionArn(v string) *DeleteStateMachineVersionInput

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (DeleteStateMachineVersionInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStateMachineVersionInput) Validate added in v1.42.9

func (s *DeleteStateMachineVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStateMachineVersionOutput added in v1.42.9

type DeleteStateMachineVersionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStateMachineVersionOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStateMachineVersionOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeActivityInput

type DescribeActivityInput struct {

	// The Amazon Resource Name (ARN) of the activity to describe.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeActivityInput) GoString

func (s DescribeActivityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActivityInput) Validate

func (s *DescribeActivityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeActivityOutput

type DescribeActivityOutput struct {

	// The Amazon Resource Name (ARN) that identifies the activity.
	//
	// ActivityArn is a required field
	ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"`

	// The date the activity is created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The name of the activity.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeActivityOutput) GoString

func (s DescribeActivityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExecutionInput

type DescribeExecutionInput struct {

	// The Amazon Resource Name (ARN) of the execution to describe.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExecutionInput) GoString

func (s DescribeExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 cause string if the state machine execution failed.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeExecutionOutput's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error string if the state machine execution failed.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeExecutionOutput's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) that identifies the execution.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// The string that contains the JSON input data of the execution. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeExecutionOutput's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Provides details about execution input or output.
	InputDetails *CloudWatchEventsExecutionDataDetails `locationName:"inputDetails" type:"structure"`

	// The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched
	// this execution.
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"`

	// The name of the execution.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The JSON output data of the execution. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// This field is set only if the execution succeeds. If the execution fails,
	// this field is null.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeExecutionOutput's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Provides details about execution input or output.
	OutputDetails *CloudWatchEventsExecutionDataDetails `locationName:"outputDetails" type:"structure"`

	// The date the execution is started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the state machine alias associated with
	// the execution. The alias ARN is a combination of state machine ARN and the
	// alias name separated by a colon (:). For example, stateMachineARN:PROD.
	//
	// If you start an execution from a StartExecution request with a state machine
	// version ARN, this field will be null.
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string"`

	// 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 Amazon Resource Name (ARN) of the state machine version associated with
	// the execution. The version ARN is a combination of state machine ARN and
	// the version number separated by a colon (:). For example, stateMachineARN:1.
	//
	// If you start an execution from a StartExecution request without specifying
	// a state machine version or alias ARN, Step Functions returns a null value.
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string"`

	// The current status of the execution.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ExecutionStatus"`

	// If the execution ended, the date the execution stopped.
	StopDate *time.Time `locationName:"stopDate" type:"timestamp"`

	// The X-Ray trace header that was passed to the execution.
	TraceHeader *string `locationName:"traceHeader" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExecutionOutput) GoString

func (s DescribeExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionOutput) SetCause added in v1.42.9

SetCause sets the Cause field's value.

func (*DescribeExecutionOutput) SetError added in v1.42.9

SetError sets the Error field's value.

func (*DescribeExecutionOutput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (*DescribeExecutionOutput) SetInput

SetInput sets the Input field's value.

func (*DescribeExecutionOutput) SetInputDetails

SetInputDetails sets the InputDetails field's value.

func (*DescribeExecutionOutput) SetMapRunArn added in v1.42.9

SetMapRunArn sets the MapRunArn 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) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (*DescribeExecutionOutput) SetStartDate

SetStartDate sets the StartDate field's value.

func (*DescribeExecutionOutput) SetStateMachineAliasArn added in v1.42.9

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

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (*DescribeExecutionOutput) SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*DescribeExecutionOutput) SetStateMachineVersionArn added in v1.42.9

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

SetStateMachineVersionArn sets the StateMachineVersionArn 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) SetTraceHeader

SetTraceHeader sets the TraceHeader field's value.

func (DescribeExecutionOutput) String

func (s DescribeExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMapRunInput added in v1.42.9

type DescribeMapRunInput struct {

	// The Amazon Resource Name (ARN) that identifies a Map Run.
	//
	// MapRunArn is a required field
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMapRunInput) GoString added in v1.42.9

func (s DescribeMapRunInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapRunInput) SetMapRunArn added in v1.42.9

func (s *DescribeMapRunInput) SetMapRunArn(v string) *DescribeMapRunInput

SetMapRunArn sets the MapRunArn field's value.

func (DescribeMapRunInput) String added in v1.42.9

func (s DescribeMapRunInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapRunInput) Validate added in v1.42.9

func (s *DescribeMapRunInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMapRunOutput added in v1.42.9

type DescribeMapRunOutput struct {

	// The Amazon Resource Name (ARN) that identifies the execution in which the
	// Map Run was started.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// A JSON object that contains information about the total number of child workflow
	// executions for the Map Run, and the count of child workflow executions for
	// each status, such as failed and succeeded.
	//
	// ExecutionCounts is a required field
	ExecutionCounts *MapRunExecutionCounts `locationName:"executionCounts" type:"structure" required:"true"`

	// A JSON object that contains information about the total number of items,
	// and the item count for each processing status, such as pending and failed.
	//
	// ItemCounts is a required field
	ItemCounts *MapRunItemCounts `locationName:"itemCounts" type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) that identifies a Map Run.
	//
	// MapRunArn is a required field
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"`

	// The maximum number of child workflow executions configured to run in parallel
	// for the Map Run at the same time.
	//
	// MaxConcurrency is a required field
	MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer" required:"true"`

	// The date when the Map Run was started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The current status of the Map Run.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"MapRunStatus"`

	// The date when the Map Run was stopped.
	StopDate *time.Time `locationName:"stopDate" type:"timestamp"`

	// The maximum number of failed child workflow executions before the Map Run
	// fails.
	//
	// ToleratedFailureCount is a required field
	ToleratedFailureCount *int64 `locationName:"toleratedFailureCount" type:"long" required:"true"`

	// The maximum percentage of failed child workflow executions before the Map
	// Run fails.
	//
	// ToleratedFailurePercentage is a required field
	ToleratedFailurePercentage *float64 `locationName:"toleratedFailurePercentage" type:"float" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMapRunOutput) GoString added in v1.42.9

func (s DescribeMapRunOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMapRunOutput) SetExecutionArn added in v1.42.9

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

SetExecutionArn sets the ExecutionArn field's value.

func (*DescribeMapRunOutput) SetExecutionCounts added in v1.42.9

SetExecutionCounts sets the ExecutionCounts field's value.

func (*DescribeMapRunOutput) SetItemCounts added in v1.42.9

SetItemCounts sets the ItemCounts field's value.

func (*DescribeMapRunOutput) SetMapRunArn added in v1.42.9

func (s *DescribeMapRunOutput) SetMapRunArn(v string) *DescribeMapRunOutput

SetMapRunArn sets the MapRunArn field's value.

func (*DescribeMapRunOutput) SetMaxConcurrency added in v1.42.9

func (s *DescribeMapRunOutput) SetMaxConcurrency(v int64) *DescribeMapRunOutput

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*DescribeMapRunOutput) SetStartDate added in v1.42.9

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

SetStartDate sets the StartDate field's value.

func (*DescribeMapRunOutput) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (*DescribeMapRunOutput) SetStopDate added in v1.42.9

SetStopDate sets the StopDate field's value.

func (*DescribeMapRunOutput) SetToleratedFailureCount added in v1.42.9

func (s *DescribeMapRunOutput) SetToleratedFailureCount(v int64) *DescribeMapRunOutput

SetToleratedFailureCount sets the ToleratedFailureCount field's value.

func (*DescribeMapRunOutput) SetToleratedFailurePercentage added in v1.42.9

func (s *DescribeMapRunOutput) SetToleratedFailurePercentage(v float64) *DescribeMapRunOutput

SetToleratedFailurePercentage sets the ToleratedFailurePercentage field's value.

func (DescribeMapRunOutput) String added in v1.42.9

func (s DescribeMapRunOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStateMachineAliasInput added in v1.42.9

type DescribeStateMachineAliasInput struct {

	// The Amazon Resource Name (ARN) of the state machine alias.
	//
	// StateMachineAliasArn is a required field
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineAliasInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineAliasInput) SetStateMachineAliasArn added in v1.42.9

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (DescribeStateMachineAliasInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineAliasInput) Validate added in v1.42.9

func (s *DescribeStateMachineAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStateMachineAliasOutput added in v1.42.9

type DescribeStateMachineAliasOutput struct {

	// The date the state machine alias was created.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// A description of the alias.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeStateMachineAliasOutput's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

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

	// The routing configuration of the alias.
	RoutingConfiguration []*RoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the state machine alias.
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string"`

	// The date the state machine alias was last updated.
	//
	// For a newly created state machine, this is the same as the creation date.
	UpdateDate *time.Time `locationName:"updateDate" type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineAliasOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineAliasOutput) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*DescribeStateMachineAliasOutput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*DescribeStateMachineAliasOutput) SetName added in v1.42.9

SetName sets the Name field's value.

func (*DescribeStateMachineAliasOutput) SetRoutingConfiguration added in v1.42.9

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*DescribeStateMachineAliasOutput) SetStateMachineAliasArn added in v1.42.9

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (*DescribeStateMachineAliasOutput) SetUpdateDate added in v1.42.9

SetUpdateDate sets the UpdateDate field's value.

func (DescribeStateMachineAliasOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStateMachineForExecutionInput

type DescribeStateMachineForExecutionInput struct {

	// The Amazon Resource Name (ARN) of the execution you want state machine information
	// for.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineForExecutionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineForExecutionInput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (DescribeStateMachineForExecutionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineForExecutionInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeStateMachineForExecutionOutput

type DescribeStateMachineForExecutionOutput struct {

	// The Amazon States Language definition of the state machine. See Amazon States
	// Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).
	//
	// Definition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeStateMachineForExecutionOutput's
	// String and GoString methods.
	//
	// Definition is a required field
	Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"`

	// A user-defined or an auto-generated string that identifies a Map state. This
	// field is returned only if the executionArn is a child workflow execution
	// that was started by a Distributed Map state.
	Label *string `locationName:"label" type:"string"`

	// The LoggingConfiguration data type is used to set CloudWatch Logs options.
	LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"`

	// The Amazon Resource Name (ARN) of the Map Run that started the child workflow
	// execution. This field is returned only if the executionArn is a child workflow
	// execution that was started by a Distributed Map state.
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"`

	// The name of the state machine associated with the execution.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The revision identifier for the state machine. The first revision ID when
	// you create the state machine is null.
	//
	// Use the state machine revisionId parameter to compare the revision of a state
	// machine with the configuration of the state machine used for executions without
	// performing a diff of the properties, such as definition and roleArn.
	RevisionId *string `locationName:"revisionId" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role of the State Machine for the
	// execution.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the state machine associated with the execution.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// Selects whether X-Ray tracing is enabled.
	TracingConfiguration *TracingConfiguration `locationName:"tracingConfiguration" type:"structure"`

	// The date and time the state machine associated with an execution was updated.
	// For a newly created state machine, this is the creation date.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineForExecutionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineForExecutionOutput) SetDefinition

SetDefinition sets the Definition field's value.

func (*DescribeStateMachineForExecutionOutput) SetLabel added in v1.42.9

SetLabel sets the Label field's value.

func (*DescribeStateMachineForExecutionOutput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*DescribeStateMachineForExecutionOutput) SetMapRunArn added in v1.42.9

SetMapRunArn sets the MapRunArn field's value.

func (*DescribeStateMachineForExecutionOutput) SetName

SetName sets the Name field's value.

func (*DescribeStateMachineForExecutionOutput) SetRevisionId added in v1.42.9

SetRevisionId sets the RevisionId field's value.

func (*DescribeStateMachineForExecutionOutput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DescribeStateMachineForExecutionOutput) SetStateMachineArn

SetStateMachineArn sets the StateMachineArn field's value.

func (*DescribeStateMachineForExecutionOutput) SetTracingConfiguration

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*DescribeStateMachineForExecutionOutput) SetUpdateDate

SetUpdateDate sets the UpdateDate field's value.

func (DescribeStateMachineForExecutionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStateMachineInput

type DescribeStateMachineInput struct {

	// The Amazon Resource Name (ARN) of the state machine for which you want the
	// information.
	//
	// If you specify a state machine version ARN, this API returns details about
	// that version. The version ARN is a combination of state machine ARN and the
	// version number separated by a colon (:). For example, stateMachineARN:1.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineInput) GoString

func (s DescribeStateMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineInput) SetStateMachineArn

SetStateMachineArn sets the StateMachineArn field's value.

func (DescribeStateMachineInput) String

func (s DescribeStateMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineInput) Validate

func (s *DescribeStateMachineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStateMachineOutput

type DescribeStateMachineOutput struct {

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

	// The Amazon States Language definition of the state machine. See Amazon States
	// Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).
	//
	// Definition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeStateMachineOutput's
	// String and GoString methods.
	//
	// Definition is a required field
	Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"`

	// The description of the state machine version.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeStateMachineOutput's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// A user-defined or an auto-generated string that identifies a Map state. This
	// parameter is present only if the stateMachineArn specified in input is a
	// qualified state machine ARN.
	Label *string `locationName:"label" type:"string"`

	// The LoggingConfiguration data type is used to set CloudWatch Logs options.
	LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"`

	// The name of the state machine.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The revision identifier for the state machine.
	//
	// Use the revisionId parameter to compare between versions of a state machine
	// configuration used for executions without performing a diff of the properties,
	// such as definition and roleArn.
	RevisionId *string `locationName:"revisionId" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role used when creating this state
	// machine. (The IAM role maintains security by granting Step Functions access
	// to Amazon Web Services resources.)
	//
	// 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.
	//
	// If you specified a state machine version ARN in your request, the API returns
	// the version ARN. The version ARN is a combination of state machine ARN and
	// the version number separated by a colon (:). For example, stateMachineARN:1.
	//
	// 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"`

	// Selects whether X-Ray tracing is enabled.
	TracingConfiguration *TracingConfiguration `locationName:"tracingConfiguration" type:"structure"`

	// The type of the state machine (STANDARD or EXPRESS).
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"StateMachineType"`
	// contains filtered or unexported fields
}

func (DescribeStateMachineOutput) GoString

func (s DescribeStateMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStateMachineOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeStateMachineOutput) SetDefinition

SetDefinition sets the Definition field's value.

func (*DescribeStateMachineOutput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*DescribeStateMachineOutput) SetLabel added in v1.42.9

SetLabel sets the Label field's value.

func (*DescribeStateMachineOutput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*DescribeStateMachineOutput) SetName

SetName sets the Name field's value.

func (*DescribeStateMachineOutput) SetRevisionId added in v1.42.9

SetRevisionId sets the RevisionId 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) SetTracingConfiguration

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*DescribeStateMachineOutput) SetType

SetType sets the Type field's value.

func (DescribeStateMachineOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionAbortedEventDetails

type ExecutionAbortedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionAbortedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionAbortedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about an abort of an execution.

func (ExecutionAbortedEventDetails) GoString

func (s ExecutionAbortedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionAlreadyExists

type ExecutionAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The execution has the same name as another execution (but a different input).

Executions with the same name and input are considered idempotent.

func (*ExecutionAlreadyExists) Code

func (s *ExecutionAlreadyExists) Code() string

Code returns the exception type name.

func (*ExecutionAlreadyExists) Error

func (s *ExecutionAlreadyExists) Error() string

func (ExecutionAlreadyExists) GoString

func (s ExecutionAlreadyExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionAlreadyExists) Message

func (s *ExecutionAlreadyExists) Message() string

Message returns the exception's message.

func (*ExecutionAlreadyExists) OrigErr

func (s *ExecutionAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExecutionAlreadyExists) RequestID

func (s *ExecutionAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExecutionAlreadyExists) StatusCode

func (s *ExecutionAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExecutionAlreadyExists) String

func (s ExecutionAlreadyExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionDoesNotExist

type ExecutionDoesNotExist struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified execution does not exist.

func (*ExecutionDoesNotExist) Code

func (s *ExecutionDoesNotExist) Code() string

Code returns the exception type name.

func (*ExecutionDoesNotExist) Error

func (s *ExecutionDoesNotExist) Error() string

func (ExecutionDoesNotExist) GoString

func (s ExecutionDoesNotExist) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionDoesNotExist) Message

func (s *ExecutionDoesNotExist) Message() string

Message returns the exception's message.

func (*ExecutionDoesNotExist) OrigErr

func (s *ExecutionDoesNotExist) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExecutionDoesNotExist) RequestID

func (s *ExecutionDoesNotExist) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExecutionDoesNotExist) StatusCode

func (s *ExecutionDoesNotExist) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExecutionDoesNotExist) String

func (s ExecutionDoesNotExist) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionFailedEventDetails

type ExecutionFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about an execution failure event.

func (ExecutionFailedEventDetails) GoString

func (s ExecutionFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionLimitExceeded

type ExecutionLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ExecutionLimitExceeded) Code

func (s *ExecutionLimitExceeded) Code() string

Code returns the exception type name.

func (*ExecutionLimitExceeded) Error

func (s *ExecutionLimitExceeded) Error() string

func (ExecutionLimitExceeded) GoString

func (s ExecutionLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionLimitExceeded) Message

func (s *ExecutionLimitExceeded) Message() string

Message returns the exception's message.

func (*ExecutionLimitExceeded) OrigErr

func (s *ExecutionLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExecutionLimitExceeded) RequestID

func (s *ExecutionLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExecutionLimitExceeded) StatusCode

func (s *ExecutionLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExecutionLimitExceeded) String

func (s ExecutionLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 total number of items processed in a child workflow execution. This field
	// is returned only if mapRunArn was specified in the ListExecutions API action.
	// If stateMachineArn was specified in ListExecutions, the itemCount field isn't
	// returned.
	ItemCount *int64 `locationName:"itemCount" type:"integer"`

	// The Amazon Resource Name (ARN) of a Map Run. This field is returned only
	// if mapRunArn was specified in the ListExecutions API action. If stateMachineArn
	// was specified in ListExecutions, the mapRunArn isn't returned.
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"`

	// The name of the execution.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The date the execution started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the state machine alias used to start an
	// execution.
	//
	// If the state machine execution was started with an unqualified ARN or a version
	// ARN, it returns null.
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine that ran the execution.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the state machine version associated with
	// the execution.
	//
	// If the state machine execution was started with an unqualified ARN, it returns
	// null.
	//
	// If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn
	// and stateMachineVersionArn parameters contain the respective values.
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string"`

	// 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"`
	// contains filtered or unexported fields
}

Contains details about an execution.

func (ExecutionListItem) GoString

func (s ExecutionListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionListItem) SetExecutionArn

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

SetExecutionArn sets the ExecutionArn field's value.

func (*ExecutionListItem) SetItemCount added in v1.42.9

func (s *ExecutionListItem) SetItemCount(v int64) *ExecutionListItem

SetItemCount sets the ItemCount field's value.

func (*ExecutionListItem) SetMapRunArn added in v1.42.9

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

SetMapRunArn sets the MapRunArn 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) SetStateMachineAliasArn added in v1.42.9

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

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (*ExecutionListItem) SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*ExecutionListItem) SetStateMachineVersionArn added in v1.42.9

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

SetStateMachineVersionArn sets the StateMachineVersionArn 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionStartedEventDetails

type ExecutionStartedEventDetails struct {

	// The JSON data input to the execution. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionStartedEventDetails's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Contains details about the input for an execution history event.
	InputDetails *HistoryEventExecutionDataDetails `locationName:"inputDetails" type:"structure"`

	// The Amazon Resource Name (ARN) of the IAM role used for executing Lambda
	// tasks.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) that identifies a state machine alias used
	// for starting the state machine execution.
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) that identifies a state machine version used
	// for starting the state machine execution.
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the start of the execution.

func (ExecutionStartedEventDetails) GoString

func (s ExecutionStartedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionStartedEventDetails) SetInput

SetInput sets the Input field's value.

func (*ExecutionStartedEventDetails) SetInputDetails

SetInputDetails sets the InputDetails field's value.

func (*ExecutionStartedEventDetails) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*ExecutionStartedEventDetails) SetStateMachineAliasArn added in v1.42.9

func (s *ExecutionStartedEventDetails) SetStateMachineAliasArn(v string) *ExecutionStartedEventDetails

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (*ExecutionStartedEventDetails) SetStateMachineVersionArn added in v1.42.9

func (s *ExecutionStartedEventDetails) SetStateMachineVersionArn(v string) *ExecutionStartedEventDetails

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (ExecutionStartedEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionSucceededEventDetails

type ExecutionSucceededEventDetails struct {

	// The JSON data output by the execution. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionSucceededEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the successful termination of the execution.

func (ExecutionSucceededEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionSucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*ExecutionSucceededEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (ExecutionSucceededEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionTimedOutEventDetails

type ExecutionTimedOutEventDetails struct {

	// A more detailed explanation of the cause of the timeout.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionTimedOutEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExecutionTimedOutEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about the execution timeout that occurred during the execution.

func (ExecutionTimedOutEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetActivityTaskInput

type GetActivityTaskInput struct {

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

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

func (GetActivityTaskInput) GoString

func (s GetActivityTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetActivityTaskInput) Validate

func (s *GetActivityTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetActivityTaskOutput

type GetActivityTaskOutput struct {

	// The string that contains the JSON input data for the task. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetActivityTaskOutput's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// A token that identifies the scheduled task. This token must be copied and
	// included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure
	// in order to report the progress or completion of the task.
	TaskToken *string `locationName:"taskToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetActivityTaskOutput) GoString

func (s GetActivityTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// You can select whether execution data (input or output of a history event)
	// is returned. The default is true.
	IncludeExecutionData *bool `locationName:"includeExecutionData" type:"boolean"`

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Lists events in descending order of their timeStamp.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetExecutionHistoryInput) GoString

func (s GetExecutionHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExecutionHistoryInput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (*GetExecutionHistoryInput) SetIncludeExecutionData

func (s *GetExecutionHistoryInput) SetIncludeExecutionData(v bool) *GetExecutionHistoryInput

SetIncludeExecutionData sets the IncludeExecutionData 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExecutionHistoryInput) Validate

func (s *GetExecutionHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetExecutionHistoryOutput

type GetExecutionHistoryOutput struct {

	// The list of events that occurred in the execution.
	//
	// Events is a required field
	Events []*HistoryEvent `locationName:"events" type:"list" required:"true"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetExecutionHistoryOutput) GoString

func (s GetExecutionHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HistoryEvent

type HistoryEvent struct {

	// Contains details about an activity that failed during an execution.
	ActivityFailedEventDetails *ActivityFailedEventDetails `locationName:"activityFailedEventDetails" type:"structure"`

	// Contains details about an activity schedule event that failed during an execution.
	ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails `locationName:"activityScheduleFailedEventDetails" type:"structure"`

	// Contains details about an activity scheduled during an execution.
	ActivityScheduledEventDetails *ActivityScheduledEventDetails `locationName:"activityScheduledEventDetails" type:"structure"`

	// Contains details about the start of an activity during an execution.
	ActivityStartedEventDetails *ActivityStartedEventDetails `locationName:"activityStartedEventDetails" type:"structure"`

	// Contains details about an activity that successfully terminated during an
	// execution.
	ActivitySucceededEventDetails *ActivitySucceededEventDetails `locationName:"activitySucceededEventDetails" type:"structure"`

	// Contains details about an activity timeout that occurred during an execution.
	ActivityTimedOutEventDetails *ActivityTimedOutEventDetails `locationName:"activityTimedOutEventDetails" type:"structure"`

	// Contains details about an abort of an execution.
	ExecutionAbortedEventDetails *ExecutionAbortedEventDetails `locationName:"executionAbortedEventDetails" type:"structure"`

	// Contains details about an execution failure event.
	ExecutionFailedEventDetails *ExecutionFailedEventDetails `locationName:"executionFailedEventDetails" type:"structure"`

	// Contains details about the start of the execution.
	ExecutionStartedEventDetails *ExecutionStartedEventDetails `locationName:"executionStartedEventDetails" type:"structure"`

	// Contains details about the successful termination of the execution.
	ExecutionSucceededEventDetails *ExecutionSucceededEventDetails `locationName:"executionSucceededEventDetails" type:"structure"`

	// Contains details about the execution timeout that occurred during the execution.
	ExecutionTimedOutEventDetails *ExecutionTimedOutEventDetails `locationName:"executionTimedOutEventDetails" type:"structure"`

	// The id of the event. Events are numbered sequentially, starting at one.
	//
	// Id is a required field
	Id *int64 `locationName:"id" type:"long" required:"true"`

	// Contains details about a Lambda function that failed during an execution.
	LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails `locationName:"lambdaFunctionFailedEventDetails" type:"structure"`

	// Contains details about a failed Lambda function schedule event that occurred
	// during an execution.
	LambdaFunctionScheduleFailedEventDetails *LambdaFunctionScheduleFailedEventDetails `locationName:"lambdaFunctionScheduleFailedEventDetails" type:"structure"`

	// Contains details about a Lambda function scheduled during an execution.
	LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails `locationName:"lambdaFunctionScheduledEventDetails" type:"structure"`

	// Contains details about a lambda function that failed to start during an execution.
	LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails `locationName:"lambdaFunctionStartFailedEventDetails" type:"structure"`

	// Contains details about a Lambda function that terminated successfully during
	// an execution.
	LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails `locationName:"lambdaFunctionSucceededEventDetails" type:"structure"`

	// Contains details about a Lambda function timeout that occurred during an
	// execution.
	LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails `locationName:"lambdaFunctionTimedOutEventDetails" type:"structure"`

	// Contains details about an iteration of a Map state that was aborted.
	MapIterationAbortedEventDetails *MapIterationEventDetails `locationName:"mapIterationAbortedEventDetails" type:"structure"`

	// Contains details about an iteration of a Map state that failed.
	MapIterationFailedEventDetails *MapIterationEventDetails `locationName:"mapIterationFailedEventDetails" type:"structure"`

	// Contains details about an iteration of a Map state that was started.
	MapIterationStartedEventDetails *MapIterationEventDetails `locationName:"mapIterationStartedEventDetails" type:"structure"`

	// Contains details about an iteration of a Map state that succeeded.
	MapIterationSucceededEventDetails *MapIterationEventDetails `locationName:"mapIterationSucceededEventDetails" type:"structure"`

	// Contains error and cause details about a Map Run that failed.
	MapRunFailedEventDetails *MapRunFailedEventDetails `locationName:"mapRunFailedEventDetails" type:"structure"`

	// Contains details, such as mapRunArn, and the start date and time of a Map
	// Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was
	// started.
	MapRunStartedEventDetails *MapRunStartedEventDetails `locationName:"mapRunStartedEventDetails" type:"structure"`

	// Contains details about Map state that was started.
	MapStateStartedEventDetails *MapStateStartedEventDetails `locationName:"mapStateStartedEventDetails" type:"structure"`

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

	// Contains details about a state entered during an execution.
	StateEnteredEventDetails *StateEnteredEventDetails `locationName:"stateEnteredEventDetails" type:"structure"`

	// Contains details about an exit from a state during an execution.
	StateExitedEventDetails *StateExitedEventDetails `locationName:"stateExitedEventDetails" type:"structure"`

	// Contains details about the failure of a task.
	TaskFailedEventDetails *TaskFailedEventDetails `locationName:"taskFailedEventDetails" type:"structure"`

	// Contains details about a task that was scheduled.
	TaskScheduledEventDetails *TaskScheduledEventDetails `locationName:"taskScheduledEventDetails" type:"structure"`

	// Contains details about a task that failed to start.
	TaskStartFailedEventDetails *TaskStartFailedEventDetails `locationName:"taskStartFailedEventDetails" type:"structure"`

	// Contains details about a task that was started.
	TaskStartedEventDetails *TaskStartedEventDetails `locationName:"taskStartedEventDetails" type:"structure"`

	// Contains details about a task that where the submit failed.
	TaskSubmitFailedEventDetails *TaskSubmitFailedEventDetails `locationName:"taskSubmitFailedEventDetails" type:"structure"`

	// Contains details about a submitted task.
	TaskSubmittedEventDetails *TaskSubmittedEventDetails `locationName:"taskSubmittedEventDetails" type:"structure"`

	// Contains details about a task that succeeded.
	TaskSucceededEventDetails *TaskSucceededEventDetails `locationName:"taskSucceededEventDetails" type:"structure"`

	// Contains details about a task that timed out.
	TaskTimedOutEventDetails *TaskTimedOutEventDetails `locationName:"taskTimedOutEventDetails" type:"structure"`

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

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

Contains details about the events of an execution.

func (HistoryEvent) GoString

func (s HistoryEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetMapIterationAbortedEventDetails

func (s *HistoryEvent) SetMapIterationAbortedEventDetails(v *MapIterationEventDetails) *HistoryEvent

SetMapIterationAbortedEventDetails sets the MapIterationAbortedEventDetails field's value.

func (*HistoryEvent) SetMapIterationFailedEventDetails

func (s *HistoryEvent) SetMapIterationFailedEventDetails(v *MapIterationEventDetails) *HistoryEvent

SetMapIterationFailedEventDetails sets the MapIterationFailedEventDetails field's value.

func (*HistoryEvent) SetMapIterationStartedEventDetails

func (s *HistoryEvent) SetMapIterationStartedEventDetails(v *MapIterationEventDetails) *HistoryEvent

SetMapIterationStartedEventDetails sets the MapIterationStartedEventDetails field's value.

func (*HistoryEvent) SetMapIterationSucceededEventDetails

func (s *HistoryEvent) SetMapIterationSucceededEventDetails(v *MapIterationEventDetails) *HistoryEvent

SetMapIterationSucceededEventDetails sets the MapIterationSucceededEventDetails field's value.

func (*HistoryEvent) SetMapRunFailedEventDetails added in v1.42.9

func (s *HistoryEvent) SetMapRunFailedEventDetails(v *MapRunFailedEventDetails) *HistoryEvent

SetMapRunFailedEventDetails sets the MapRunFailedEventDetails field's value.

func (*HistoryEvent) SetMapRunStartedEventDetails added in v1.42.9

func (s *HistoryEvent) SetMapRunStartedEventDetails(v *MapRunStartedEventDetails) *HistoryEvent

SetMapRunStartedEventDetails sets the MapRunStartedEventDetails field's value.

func (*HistoryEvent) SetMapStateStartedEventDetails

func (s *HistoryEvent) SetMapStateStartedEventDetails(v *MapStateStartedEventDetails) *HistoryEvent

SetMapStateStartedEventDetails sets the MapStateStartedEventDetails 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) SetTaskFailedEventDetails

func (s *HistoryEvent) SetTaskFailedEventDetails(v *TaskFailedEventDetails) *HistoryEvent

SetTaskFailedEventDetails sets the TaskFailedEventDetails field's value.

func (*HistoryEvent) SetTaskScheduledEventDetails

func (s *HistoryEvent) SetTaskScheduledEventDetails(v *TaskScheduledEventDetails) *HistoryEvent

SetTaskScheduledEventDetails sets the TaskScheduledEventDetails field's value.

func (*HistoryEvent) SetTaskStartFailedEventDetails

func (s *HistoryEvent) SetTaskStartFailedEventDetails(v *TaskStartFailedEventDetails) *HistoryEvent

SetTaskStartFailedEventDetails sets the TaskStartFailedEventDetails field's value.

func (*HistoryEvent) SetTaskStartedEventDetails

func (s *HistoryEvent) SetTaskStartedEventDetails(v *TaskStartedEventDetails) *HistoryEvent

SetTaskStartedEventDetails sets the TaskStartedEventDetails field's value.

func (*HistoryEvent) SetTaskSubmitFailedEventDetails

func (s *HistoryEvent) SetTaskSubmitFailedEventDetails(v *TaskSubmitFailedEventDetails) *HistoryEvent

SetTaskSubmitFailedEventDetails sets the TaskSubmitFailedEventDetails field's value.

func (*HistoryEvent) SetTaskSubmittedEventDetails

func (s *HistoryEvent) SetTaskSubmittedEventDetails(v *TaskSubmittedEventDetails) *HistoryEvent

SetTaskSubmittedEventDetails sets the TaskSubmittedEventDetails field's value.

func (*HistoryEvent) SetTaskSucceededEventDetails

func (s *HistoryEvent) SetTaskSucceededEventDetails(v *TaskSucceededEventDetails) *HistoryEvent

SetTaskSucceededEventDetails sets the TaskSucceededEventDetails field's value.

func (*HistoryEvent) SetTaskTimedOutEventDetails

func (s *HistoryEvent) SetTaskTimedOutEventDetails(v *TaskTimedOutEventDetails) *HistoryEvent

SetTaskTimedOutEventDetails sets the TaskTimedOutEventDetails 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HistoryEventExecutionDataDetails

type HistoryEventExecutionDataDetails struct {

	// Indicates whether input or output was truncated in the response. Always false
	// for API calls.
	Truncated *bool `locationName:"truncated" type:"boolean"`
	// contains filtered or unexported fields
}

Provides details about input or output in an execution history event.

func (HistoryEventExecutionDataDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HistoryEventExecutionDataDetails) SetTruncated

SetTruncated sets the Truncated field's value.

func (HistoryEventExecutionDataDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidArn

type InvalidArn struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided Amazon Resource Name (ARN) is not valid.

func (*InvalidArn) Code

func (s *InvalidArn) Code() string

Code returns the exception type name.

func (*InvalidArn) Error

func (s *InvalidArn) Error() string

func (InvalidArn) GoString

func (s InvalidArn) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidArn) Message

func (s *InvalidArn) Message() string

Message returns the exception's message.

func (*InvalidArn) OrigErr

func (s *InvalidArn) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArn) RequestID

func (s *InvalidArn) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArn) StatusCode

func (s *InvalidArn) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArn) String

func (s InvalidArn) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidDefinition

type InvalidDefinition struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided Amazon States Language definition is not valid.

func (*InvalidDefinition) Code

func (s *InvalidDefinition) Code() string

Code returns the exception type name.

func (*InvalidDefinition) Error

func (s *InvalidDefinition) Error() string

func (InvalidDefinition) GoString

func (s InvalidDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidDefinition) Message

func (s *InvalidDefinition) Message() string

Message returns the exception's message.

func (*InvalidDefinition) OrigErr

func (s *InvalidDefinition) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidDefinition) RequestID

func (s *InvalidDefinition) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidDefinition) StatusCode

func (s *InvalidDefinition) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidDefinition) String

func (s InvalidDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidExecutionInput

type InvalidExecutionInput struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided JSON input data is not valid.

func (*InvalidExecutionInput) Code

func (s *InvalidExecutionInput) Code() string

Code returns the exception type name.

func (*InvalidExecutionInput) Error

func (s *InvalidExecutionInput) Error() string

func (InvalidExecutionInput) GoString

func (s InvalidExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidExecutionInput) Message

func (s *InvalidExecutionInput) Message() string

Message returns the exception's message.

func (*InvalidExecutionInput) OrigErr

func (s *InvalidExecutionInput) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidExecutionInput) RequestID

func (s *InvalidExecutionInput) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidExecutionInput) StatusCode

func (s *InvalidExecutionInput) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidExecutionInput) String

func (s InvalidExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidLoggingConfiguration

type InvalidLoggingConfiguration struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*InvalidLoggingConfiguration) Code

Code returns the exception type name.

func (*InvalidLoggingConfiguration) Error

func (InvalidLoggingConfiguration) GoString

func (s InvalidLoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidLoggingConfiguration) Message

func (s *InvalidLoggingConfiguration) Message() string

Message returns the exception's message.

func (*InvalidLoggingConfiguration) OrigErr

func (s *InvalidLoggingConfiguration) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidLoggingConfiguration) RequestID

func (s *InvalidLoggingConfiguration) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidLoggingConfiguration) StatusCode

func (s *InvalidLoggingConfiguration) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidLoggingConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidName

type InvalidName struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided name is not valid.

func (*InvalidName) Code

func (s *InvalidName) Code() string

Code returns the exception type name.

func (*InvalidName) Error

func (s *InvalidName) Error() string

func (InvalidName) GoString

func (s InvalidName) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidName) Message

func (s *InvalidName) Message() string

Message returns the exception's message.

func (*InvalidName) OrigErr

func (s *InvalidName) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidName) RequestID

func (s *InvalidName) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidName) StatusCode

func (s *InvalidName) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidName) String

func (s InvalidName) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidOutput

type InvalidOutput struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided JSON output data is not valid.

func (*InvalidOutput) Code

func (s *InvalidOutput) Code() string

Code returns the exception type name.

func (*InvalidOutput) Error

func (s *InvalidOutput) Error() string

func (InvalidOutput) GoString

func (s InvalidOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidOutput) Message

func (s *InvalidOutput) Message() string

Message returns the exception's message.

func (*InvalidOutput) OrigErr

func (s *InvalidOutput) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOutput) RequestID

func (s *InvalidOutput) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOutput) StatusCode

func (s *InvalidOutput) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidOutput) String

func (s InvalidOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidToken

type InvalidToken struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided token is not valid.

func (*InvalidToken) Code

func (s *InvalidToken) Code() string

Code returns the exception type name.

func (*InvalidToken) Error

func (s *InvalidToken) Error() string

func (InvalidToken) GoString

func (s InvalidToken) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidToken) Message

func (s *InvalidToken) Message() string

Message returns the exception's message.

func (*InvalidToken) OrigErr

func (s *InvalidToken) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidToken) RequestID

func (s *InvalidToken) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidToken) StatusCode

func (s *InvalidToken) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidToken) String

func (s InvalidToken) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidTracingConfiguration

type InvalidTracingConfiguration struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

func (*InvalidTracingConfiguration) Code

Code returns the exception type name.

func (*InvalidTracingConfiguration) Error

func (InvalidTracingConfiguration) GoString

func (s InvalidTracingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidTracingConfiguration) Message

func (s *InvalidTracingConfiguration) Message() string

Message returns the exception's message.

func (*InvalidTracingConfiguration) OrigErr

func (s *InvalidTracingConfiguration) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTracingConfiguration) RequestID

func (s *InvalidTracingConfiguration) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTracingConfiguration) StatusCode

func (s *InvalidTracingConfiguration) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTracingConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionFailedEventDetails

type LambdaFunctionFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about a Lambda function that failed during an execution.

func (LambdaFunctionFailedEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionScheduleFailedEventDetails

type LambdaFunctionScheduleFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionScheduleFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionScheduleFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about a failed Lambda function schedule event that occurred during an execution.

func (LambdaFunctionScheduleFailedEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionScheduledEventDetails

type LambdaFunctionScheduledEventDetails struct {

	// The JSON data input to the Lambda function. Length constraints apply to the
	// payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionScheduledEventDetails's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Contains details about input for an execution history event.
	InputDetails *HistoryEventExecutionDataDetails `locationName:"inputDetails" type:"structure"`

	// 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 credentials that Step Functions uses for the task.
	TaskCredentials *TaskCredentials `locationName:"taskCredentials" type:"structure"`

	// The maximum allowed duration of the Lambda function.
	TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"`
	// contains filtered or unexported fields
}

Contains details about a Lambda function scheduled during an execution.

func (LambdaFunctionScheduledEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunctionScheduledEventDetails) SetInput

SetInput sets the Input field's value.

func (*LambdaFunctionScheduledEventDetails) SetInputDetails

SetInputDetails sets the InputDetails field's value.

func (*LambdaFunctionScheduledEventDetails) SetResource

SetResource sets the Resource field's value.

func (*LambdaFunctionScheduledEventDetails) SetTaskCredentials added in v1.42.9

SetTaskCredentials sets the TaskCredentials field's value.

func (*LambdaFunctionScheduledEventDetails) SetTimeoutInSeconds

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (LambdaFunctionScheduledEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionStartFailedEventDetails

type LambdaFunctionStartFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionStartFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionStartFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about a lambda function that failed to start during an execution.

func (LambdaFunctionStartFailedEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionSucceededEventDetails

type LambdaFunctionSucceededEventDetails struct {

	// The JSON data output by the Lambda function. Length constraints apply to
	// the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionSucceededEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about a Lambda function that successfully terminated during an execution.

func (LambdaFunctionSucceededEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunctionSucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*LambdaFunctionSucceededEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (LambdaFunctionSucceededEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaFunctionTimedOutEventDetails

type LambdaFunctionTimedOutEventDetails struct {

	// A more detailed explanation of the cause of the timeout.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionTimedOutEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by LambdaFunctionTimedOutEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about a Lambda function timeout that occurred during an execution.

func (LambdaFunctionTimedOutEventDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListActivitiesInput

type ListActivitiesInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListActivitiesInput) GoString

func (s ListActivitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActivitiesInput) Validate

func (s *ListActivitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListActivitiesOutput

type ListActivitiesOutput struct {

	// The list of activities.
	//
	// Activities is a required field
	Activities []*ActivityListItem `locationName:"activities" type:"list" required:"true"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListActivitiesOutput) GoString

func (s ListActivitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExecutionsInput

type ListExecutionsInput struct {

	// The Amazon Resource Name (ARN) of the Map Run that started the child workflow
	// executions. If the mapRunArn field is specified, a list of all of the child
	// workflow executions started by a Map Run is returned. For more information,
	// see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html)
	// in the Step Functions Developer Guide.
	//
	// You can specify either a mapRunArn or a stateMachineArn, but not both.
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"`

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine whose executions is listed.
	//
	// You can specify either a mapRunArn or a stateMachineArn, but not both.
	//
	// You can also return a list of executions associated with a specific alias
	// (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html)
	// or version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html),
	// by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string"`

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

func (ListExecutionsInput) GoString

func (s ListExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) SetMapRunArn added in v1.42.9

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

SetMapRunArn sets the MapRunArn field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) Validate

func (s *ListExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExecutionsOutput

type ListExecutionsOutput struct {

	// The list of matching executions.
	//
	// Executions is a required field
	Executions []*ExecutionListItem `locationName:"executions" type:"list" required:"true"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExecutionsOutput) GoString

func (s ListExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMapRunsInput added in v1.42.9

type ListMapRunsInput struct {

	// The Amazon Resource Name (ARN) of the execution for which the Map Runs must
	// be listed.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMapRunsInput) GoString added in v1.42.9

func (s ListMapRunsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapRunsInput) SetExecutionArn added in v1.42.9

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

SetExecutionArn sets the ExecutionArn field's value.

func (*ListMapRunsInput) SetMaxResults added in v1.42.9

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

SetMaxResults sets the MaxResults field's value.

func (*ListMapRunsInput) SetNextToken added in v1.42.9

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

SetNextToken sets the NextToken field's value.

func (ListMapRunsInput) String added in v1.42.9

func (s ListMapRunsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapRunsInput) Validate added in v1.42.9

func (s *ListMapRunsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMapRunsOutput added in v1.42.9

type ListMapRunsOutput struct {

	// An array that lists information related to a Map Run, such as the Amazon
	// Resource Name (ARN) of the Map Run and the ARN of the state machine that
	// started the Map Run.
	//
	// MapRuns is a required field
	MapRuns []*MapRunListItem `locationName:"mapRuns" type:"list" required:"true"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMapRunsOutput) GoString added in v1.42.9

func (s ListMapRunsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMapRunsOutput) SetMapRuns added in v1.42.9

func (s *ListMapRunsOutput) SetMapRuns(v []*MapRunListItem) *ListMapRunsOutput

SetMapRuns sets the MapRuns field's value.

func (*ListMapRunsOutput) SetNextToken added in v1.42.9

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

SetNextToken sets the NextToken field's value.

func (ListMapRunsOutput) String added in v1.42.9

func (s ListMapRunsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStateMachineAliasesInput added in v1.42.9

type ListStateMachineAliasesInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine for which you want to
	// list aliases.
	//
	// If you specify a state machine version ARN, this API returns a list of aliases
	// for that version.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStateMachineAliasesInput) GoString added in v1.42.9

func (s ListStateMachineAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineAliasesInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListStateMachineAliasesInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStateMachineAliasesInput) SetStateMachineArn added in v1.42.9

SetStateMachineArn sets the StateMachineArn field's value.

func (ListStateMachineAliasesInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineAliasesInput) Validate added in v1.42.9

func (s *ListStateMachineAliasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStateMachineAliasesOutput added in v1.42.9

type ListStateMachineAliasesOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Aliases for the state machine.
	//
	// StateMachineAliases is a required field
	StateMachineAliases []*StateMachineAliasListItem `locationName:"stateMachineAliases" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStateMachineAliasesOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineAliasesOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStateMachineAliasesOutput) SetStateMachineAliases added in v1.42.9

SetStateMachineAliases sets the StateMachineAliases field's value.

func (ListStateMachineAliasesOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStateMachineVersionsInput added in v1.42.9

type ListStateMachineVersionsInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStateMachineVersionsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineVersionsInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListStateMachineVersionsInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStateMachineVersionsInput) SetStateMachineArn added in v1.42.9

SetStateMachineArn sets the StateMachineArn field's value.

func (ListStateMachineVersionsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineVersionsInput) Validate added in v1.42.9

func (s *ListStateMachineVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStateMachineVersionsOutput added in v1.42.9

type ListStateMachineVersionsOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Versions for the state machine.
	//
	// StateMachineVersions is a required field
	StateMachineVersions []*StateMachineVersionListItem `locationName:"stateMachineVersions" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStateMachineVersionsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachineVersionsOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStateMachineVersionsOutput) SetStateMachineVersions added in v1.42.9

SetStateMachineVersions sets the StateMachineVersions field's value.

func (ListStateMachineVersionsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStateMachinesInput

type ListStateMachinesInput struct {

	// The maximum number of results that are returned per call. You can use nextToken
	// to obtain further pages of results. The default is 100 and the maximum allowed
	// page size is 1000. A value of 0 uses the default.
	//
	// This is only an upper limit. The actual number of results returned per call
	// might be fewer than the specified maximum.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListStateMachinesInput) GoString

func (s ListStateMachinesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStateMachinesInput) Validate

func (s *ListStateMachinesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStateMachinesOutput

type ListStateMachinesOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// StateMachines is a required field
	StateMachines []*StateMachineListItem `locationName:"stateMachines" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStateMachinesOutput) GoString

func (s ListStateMachinesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// An array of tags associated with the resource.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogDestination

type LogDestination struct {

	// An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html)
	// in the CloudFormation User Guide.
	CloudWatchLogsLogGroup *CloudWatchLogsLogGroup `locationName:"cloudWatchLogsLogGroup" type:"structure"`
	// contains filtered or unexported fields
}

func (LogDestination) GoString

func (s LogDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestination) SetCloudWatchLogsLogGroup

func (s *LogDestination) SetCloudWatchLogsLogGroup(v *CloudWatchLogsLogGroup) *LogDestination

SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value.

func (LogDestination) String

func (s LogDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestination) Validate

func (s *LogDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LoggingConfiguration

type LoggingConfiguration struct {

	// An array of objects that describes where your execution history events will
	// be logged. Limited to size 1. Required, if your log level is not set to OFF.
	Destinations []*LogDestination `locationName:"destinations" type:"list"`

	// Determines whether execution data is included in your log. When set to false,
	// data is excluded.
	IncludeExecutionData *bool `locationName:"includeExecutionData" type:"boolean"`

	// Defines which category of execution history events are logged.
	Level *string `locationName:"level" type:"string" enum:"LogLevel"`
	// contains filtered or unexported fields
}

The LoggingConfiguration data type is used to set CloudWatch Logs options.

func (LoggingConfiguration) GoString

func (s LoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) SetDestinations

func (s *LoggingConfiguration) SetDestinations(v []*LogDestination) *LoggingConfiguration

SetDestinations sets the Destinations field's value.

func (*LoggingConfiguration) SetIncludeExecutionData

func (s *LoggingConfiguration) SetIncludeExecutionData(v bool) *LoggingConfiguration

SetIncludeExecutionData sets the IncludeExecutionData field's value.

func (*LoggingConfiguration) SetLevel

SetLevel sets the Level field's value.

func (LoggingConfiguration) String

func (s LoggingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) Validate

func (s *LoggingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MapIterationEventDetails

type MapIterationEventDetails struct {

	// The index of the array belonging to the Map state iteration.
	Index *int64 `locationName:"index" type:"integer"`

	// The name of the iteration’s parent Map state.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about an iteration of a Map state.

func (MapIterationEventDetails) GoString

func (s MapIterationEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapIterationEventDetails) SetIndex

SetIndex sets the Index field's value.

func (*MapIterationEventDetails) SetName

SetName sets the Name field's value.

func (MapIterationEventDetails) String

func (s MapIterationEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapRunExecutionCounts added in v1.42.9

type MapRunExecutionCounts struct {

	// The total number of child workflow executions that were started by a Map
	// Run and were running, but were either stopped by the user or by Step Functions
	// because the Map Run failed.
	//
	// Aborted is a required field
	Aborted *int64 `locationName:"aborted" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run, but have failed.
	//
	// Failed is a required field
	Failed *int64 `locationName:"failed" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run, but haven't started executing yet.
	//
	// Pending is a required field
	Pending *int64 `locationName:"pending" type:"long" required:"true"`

	// Returns the count of child workflow executions whose results were written
	// by ResultWriter. For more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html)
	// in the Step Functions Developer Guide.
	//
	// ResultsWritten is a required field
	ResultsWritten *int64 `locationName:"resultsWritten" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run and are currently in-progress.
	//
	// Running is a required field
	Running *int64 `locationName:"running" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run and have completed successfully.
	//
	// Succeeded is a required field
	Succeeded *int64 `locationName:"succeeded" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run and have timed out.
	//
	// TimedOut is a required field
	TimedOut *int64 `locationName:"timedOut" type:"long" required:"true"`

	// The total number of child workflow executions that were started by a Map
	// Run.
	//
	// Total is a required field
	Total *int64 `locationName:"total" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Contains details about all of the child workflow executions started by a Map Run.

func (MapRunExecutionCounts) GoString added in v1.42.9

func (s MapRunExecutionCounts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapRunExecutionCounts) SetAborted added in v1.42.9

SetAborted sets the Aborted field's value.

func (*MapRunExecutionCounts) SetFailed added in v1.42.9

SetFailed sets the Failed field's value.

func (*MapRunExecutionCounts) SetPending added in v1.42.9

SetPending sets the Pending field's value.

func (*MapRunExecutionCounts) SetResultsWritten added in v1.42.9

func (s *MapRunExecutionCounts) SetResultsWritten(v int64) *MapRunExecutionCounts

SetResultsWritten sets the ResultsWritten field's value.

func (*MapRunExecutionCounts) SetRunning added in v1.42.9

SetRunning sets the Running field's value.

func (*MapRunExecutionCounts) SetSucceeded added in v1.42.9

SetSucceeded sets the Succeeded field's value.

func (*MapRunExecutionCounts) SetTimedOut added in v1.42.9

SetTimedOut sets the TimedOut field's value.

func (*MapRunExecutionCounts) SetTotal added in v1.42.9

SetTotal sets the Total field's value.

func (MapRunExecutionCounts) String added in v1.42.9

func (s MapRunExecutionCounts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapRunFailedEventDetails added in v1.42.9

type MapRunFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MapRunFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the Map Run failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MapRunFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about a Map Run failure event that occurred during a state machine execution.

func (MapRunFailedEventDetails) GoString added in v1.42.9

func (s MapRunFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapRunFailedEventDetails) SetCause added in v1.42.9

SetCause sets the Cause field's value.

func (*MapRunFailedEventDetails) SetError added in v1.42.9

SetError sets the Error field's value.

func (MapRunFailedEventDetails) String added in v1.42.9

func (s MapRunFailedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapRunItemCounts added in v1.42.9

type MapRunItemCounts struct {

	// The total number of items processed in child workflow executions that were
	// either stopped by the user or by Step Functions, because the Map Run failed.
	//
	// Aborted is a required field
	Aborted *int64 `locationName:"aborted" type:"long" required:"true"`

	// The total number of items processed in child workflow executions that have
	// failed.
	//
	// Failed is a required field
	Failed *int64 `locationName:"failed" type:"long" required:"true"`

	// The total number of items to process in child workflow executions that haven't
	// started running yet.
	//
	// Pending is a required field
	Pending *int64 `locationName:"pending" type:"long" required:"true"`

	// Returns the count of items whose results were written by ResultWriter. For
	// more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html)
	// in the Step Functions Developer Guide.
	//
	// ResultsWritten is a required field
	ResultsWritten *int64 `locationName:"resultsWritten" type:"long" required:"true"`

	// The total number of items being processed in child workflow executions that
	// are currently in-progress.
	//
	// Running is a required field
	Running *int64 `locationName:"running" type:"long" required:"true"`

	// The total number of items processed in child workflow executions that have
	// completed successfully.
	//
	// Succeeded is a required field
	Succeeded *int64 `locationName:"succeeded" type:"long" required:"true"`

	// The total number of items processed in child workflow executions that have
	// timed out.
	//
	// TimedOut is a required field
	TimedOut *int64 `locationName:"timedOut" type:"long" required:"true"`

	// The total number of items processed in all the child workflow executions
	// started by a Map Run.
	//
	// Total is a required field
	Total *int64 `locationName:"total" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

func (MapRunItemCounts) GoString added in v1.42.9

func (s MapRunItemCounts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapRunItemCounts) SetAborted added in v1.42.9

func (s *MapRunItemCounts) SetAborted(v int64) *MapRunItemCounts

SetAborted sets the Aborted field's value.

func (*MapRunItemCounts) SetFailed added in v1.42.9

func (s *MapRunItemCounts) SetFailed(v int64) *MapRunItemCounts

SetFailed sets the Failed field's value.

func (*MapRunItemCounts) SetPending added in v1.42.9

func (s *MapRunItemCounts) SetPending(v int64) *MapRunItemCounts

SetPending sets the Pending field's value.

func (*MapRunItemCounts) SetResultsWritten added in v1.42.9

func (s *MapRunItemCounts) SetResultsWritten(v int64) *MapRunItemCounts

SetResultsWritten sets the ResultsWritten field's value.

func (*MapRunItemCounts) SetRunning added in v1.42.9

func (s *MapRunItemCounts) SetRunning(v int64) *MapRunItemCounts

SetRunning sets the Running field's value.

func (*MapRunItemCounts) SetSucceeded added in v1.42.9

func (s *MapRunItemCounts) SetSucceeded(v int64) *MapRunItemCounts

SetSucceeded sets the Succeeded field's value.

func (*MapRunItemCounts) SetTimedOut added in v1.42.9

func (s *MapRunItemCounts) SetTimedOut(v int64) *MapRunItemCounts

SetTimedOut sets the TimedOut field's value.

func (*MapRunItemCounts) SetTotal added in v1.42.9

func (s *MapRunItemCounts) SetTotal(v int64) *MapRunItemCounts

SetTotal sets the Total field's value.

func (MapRunItemCounts) String added in v1.42.9

func (s MapRunItemCounts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapRunListItem added in v1.42.9

type MapRunListItem struct {

	// The executionArn of the execution from which the Map Run was started.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Map Run.
	//
	// MapRunArn is a required field
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"`

	// The date on which the Map Run started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the executed state machine.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// The date on which the Map Run stopped.
	StopDate *time.Time `locationName:"stopDate" type:"timestamp"`
	// contains filtered or unexported fields
}

Contains details about a specific Map Run.

func (MapRunListItem) GoString added in v1.42.9

func (s MapRunListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapRunListItem) SetExecutionArn added in v1.42.9

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

SetExecutionArn sets the ExecutionArn field's value.

func (*MapRunListItem) SetMapRunArn added in v1.42.9

func (s *MapRunListItem) SetMapRunArn(v string) *MapRunListItem

SetMapRunArn sets the MapRunArn field's value.

func (*MapRunListItem) SetStartDate added in v1.42.9

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

SetStartDate sets the StartDate field's value.

func (*MapRunListItem) SetStateMachineArn added in v1.42.9

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*MapRunListItem) SetStopDate added in v1.42.9

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

SetStopDate sets the StopDate field's value.

func (MapRunListItem) String added in v1.42.9

func (s MapRunListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapRunStartedEventDetails added in v1.42.9

type MapRunStartedEventDetails struct {

	// The Amazon Resource Name (ARN) of a Map Run that was started.
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about a Map Run that was started during a state machine execution.

func (MapRunStartedEventDetails) GoString added in v1.42.9

func (s MapRunStartedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapRunStartedEventDetails) SetMapRunArn added in v1.42.9

SetMapRunArn sets the MapRunArn field's value.

func (MapRunStartedEventDetails) String added in v1.42.9

func (s MapRunStartedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MapStateStartedEventDetails

type MapStateStartedEventDetails struct {

	// The size of the array for Map state iterations.
	Length *int64 `locationName:"length" type:"integer"`
	// contains filtered or unexported fields
}

Details about a Map state that was started.

func (MapStateStartedEventDetails) GoString

func (s MapStateStartedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapStateStartedEventDetails) SetLength

SetLength sets the Length field's value.

func (MapStateStartedEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MissingRequiredParameter

type MissingRequiredParameter struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

func (*MissingRequiredParameter) Code

func (s *MissingRequiredParameter) Code() string

Code returns the exception type name.

func (*MissingRequiredParameter) Error

func (s *MissingRequiredParameter) Error() string

func (MissingRequiredParameter) GoString

func (s MissingRequiredParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MissingRequiredParameter) Message

func (s *MissingRequiredParameter) Message() string

Message returns the exception's message.

func (*MissingRequiredParameter) OrigErr

func (s *MissingRequiredParameter) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingRequiredParameter) RequestID

func (s *MissingRequiredParameter) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingRequiredParameter) StatusCode

func (s *MissingRequiredParameter) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingRequiredParameter) String

func (s MissingRequiredParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PublishStateMachineVersionInput added in v1.42.9

type PublishStateMachineVersionInput struct {

	// An optional description of the state machine version.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PublishStateMachineVersionInput's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// Only publish the state machine version if the current state machine's revision
	// ID matches the specified ID.
	//
	// Use this option to avoid publishing a version if the state machine changed
	// since you last updated it. If the specified revision ID doesn't match the
	// state machine's current revision ID, the API returns ConflictException.
	//
	// To specify an initial revision ID for a state machine with no revision ID
	// assigned, specify the string INITIAL for the revisionId parameter. For example,
	// you can specify a revisionID of INITIAL when you create a state machine using
	// the CreateStateMachine API action.
	RevisionId *string `locationName:"revisionId" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PublishStateMachineVersionInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishStateMachineVersionInput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*PublishStateMachineVersionInput) SetRevisionId added in v1.42.9

SetRevisionId sets the RevisionId field's value.

func (*PublishStateMachineVersionInput) SetStateMachineArn added in v1.42.9

SetStateMachineArn sets the StateMachineArn field's value.

func (PublishStateMachineVersionInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishStateMachineVersionInput) Validate added in v1.42.9

func (s *PublishStateMachineVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PublishStateMachineVersionOutput added in v1.42.9

type PublishStateMachineVersionOutput struct {

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

	// The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
	//
	// StateMachineVersionArn is a required field
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PublishStateMachineVersionOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishStateMachineVersionOutput) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*PublishStateMachineVersionOutput) SetStateMachineVersionArn added in v1.42.9

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (PublishStateMachineVersionOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFound

type ResourceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	ResourceName *string `locationName:"resourceName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Could not find the referenced resource.

func (*ResourceNotFound) Code

func (s *ResourceNotFound) Code() string

Code returns the exception type name.

func (*ResourceNotFound) Error

func (s *ResourceNotFound) Error() string

func (ResourceNotFound) GoString

func (s ResourceNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFound) Message

func (s *ResourceNotFound) Message() string

Message returns the exception's message.

func (*ResourceNotFound) OrigErr

func (s *ResourceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFound) RequestID

func (s *ResourceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFound) StatusCode

func (s *ResourceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFound) String

func (s ResourceNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RoutingConfigurationListItem added in v1.42.9

type RoutingConfigurationListItem struct {

	// The Amazon Resource Name (ARN) that identifies one or two state machine versions
	// defined in the routing configuration.
	//
	// If you specify the ARN of a second version, it must belong to the same state
	// machine as the first version.
	//
	// StateMachineVersionArn is a required field
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string" required:"true"`

	// The percentage of traffic you want to route to the second state machine version.
	// The sum of the weights in the routing configuration must be equal to 100.
	//
	// Weight is a required field
	Weight *int64 `locationName:"weight" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.

func (RoutingConfigurationListItem) GoString added in v1.42.9

func (s RoutingConfigurationListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoutingConfigurationListItem) SetStateMachineVersionArn added in v1.42.9

func (s *RoutingConfigurationListItem) SetStateMachineVersionArn(v string) *RoutingConfigurationListItem

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (*RoutingConfigurationListItem) SetWeight added in v1.42.9

SetWeight sets the Weight field's value.

func (RoutingConfigurationListItem) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoutingConfigurationListItem) Validate added in v1.42.9

func (s *RoutingConfigurationListItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SFN

type SFN struct {
	*client.Client
}

SFN provides the API operation methods for making requests to AWS Step Functions. See this package's package overview docs for details on the service.

SFN methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

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:

mySession := session.Must(session.NewSession())

// 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. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

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

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

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

  • 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 not valid.

  • TooManyTags You've exceeded the number of tags allowed for a resource. See the Limits Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) in the Step Functions Developer Guide.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateActivity for more information on using the CreateActivity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) CreateActivityWithContext

func (c *SFN) CreateActivityWithContext(ctx aws.Context, input *CreateActivityInput, opts ...request.Option) (*CreateActivityOutput, error)

CreateActivityWithContext is the same as CreateActivity with the addition of the ability to pass a context and additional request options.

See CreateActivity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) CreateStateMachine

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

CreateStateMachine API operation for AWS Step Functions.

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

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

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

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

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

  • InvalidDefinition The provided Amazon States Language definition is not valid.

  • InvalidName The provided name is not valid.

  • InvalidLoggingConfiguration

  • InvalidTracingConfiguration Your tracingConfiguration key does not match, or enabled has not been set to true or false.

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

  • StateMachineTypeNotSupported

  • TooManyTags You've exceeded the number of tags allowed for a resource. See the Limits Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) in the Step Functions Developer Guide.

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

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

func (*SFN) CreateStateMachineAlias added in v1.42.9

func (c *SFN) CreateStateMachineAlias(input *CreateStateMachineAliasInput) (*CreateStateMachineAliasOutput, error)

CreateStateMachineAlias API operation for AWS Step Functions.

Creates an alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) for a state machine that points to one or two versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

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 CreateStateMachineAlias for usage and error information.

Returned Error Types:

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

  • InvalidName The provided name is not valid.

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

  • StateMachineDeleting The specified state machine is being deleted.

  • ResourceNotFound Could not find the referenced resource.

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

    HTTP Status Code: 402

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineAlias

func (*SFN) CreateStateMachineAliasRequest added in v1.42.9

func (c *SFN) CreateStateMachineAliasRequest(input *CreateStateMachineAliasInput) (req *request.Request, output *CreateStateMachineAliasOutput)

CreateStateMachineAliasRequest generates a "aws/request.Request" representing the client's request for the CreateStateMachineAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStateMachineAlias for more information on using the CreateStateMachineAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineAlias

func (*SFN) CreateStateMachineAliasWithContext added in v1.42.9

func (c *SFN) CreateStateMachineAliasWithContext(ctx aws.Context, input *CreateStateMachineAliasInput, opts ...request.Option) (*CreateStateMachineAliasOutput, error)

CreateStateMachineAliasWithContext is the same as CreateStateMachineAlias with the addition of the ability to pass a context and additional request options.

See CreateStateMachineAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStateMachine for more information on using the CreateStateMachine API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) CreateStateMachineWithContext

func (c *SFN) CreateStateMachineWithContext(ctx aws.Context, input *CreateStateMachineInput, opts ...request.Option) (*CreateStateMachineOutput, error)

CreateStateMachineWithContext is the same as CreateStateMachine with the addition of the ability to pass a context and additional request options.

See CreateStateMachine for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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

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

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteActivity for more information on using the DeleteActivity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) DeleteActivityWithContext

func (c *SFN) DeleteActivityWithContext(ctx aws.Context, input *DeleteActivityInput, opts ...request.Option) (*DeleteActivityOutput, error)

DeleteActivityWithContext is the same as DeleteActivity with the addition of the ability to pass a context and additional request options.

See DeleteActivity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 deletion process.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

  • The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine

This API action also deletes all versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) and aliases (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) associated with a state machine.

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

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

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

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

func (*SFN) DeleteStateMachineAlias added in v1.42.9

func (c *SFN) DeleteStateMachineAlias(input *DeleteStateMachineAliasInput) (*DeleteStateMachineAliasOutput, error)

DeleteStateMachineAlias API operation for AWS Step Functions.

Deletes a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html).

After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.

Related operations:

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

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 DeleteStateMachineAlias for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

  • ResourceNotFound Could not find the referenced resource.

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineAlias

func (*SFN) DeleteStateMachineAliasRequest added in v1.42.9

func (c *SFN) DeleteStateMachineAliasRequest(input *DeleteStateMachineAliasInput) (req *request.Request, output *DeleteStateMachineAliasOutput)

DeleteStateMachineAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteStateMachineAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStateMachineAlias for more information on using the DeleteStateMachineAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineAlias

func (*SFN) DeleteStateMachineAliasWithContext added in v1.42.9

func (c *SFN) DeleteStateMachineAliasWithContext(ctx aws.Context, input *DeleteStateMachineAliasInput, opts ...request.Option) (*DeleteStateMachineAliasOutput, error)

DeleteStateMachineAliasWithContext is the same as DeleteStateMachineAlias with the addition of the ability to pass a context and additional request options.

See DeleteStateMachineAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStateMachine for more information on using the DeleteStateMachine API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) DeleteStateMachineVersion added in v1.42.9

func (c *SFN) DeleteStateMachineVersion(input *DeleteStateMachineVersionInput) (*DeleteStateMachineVersionOutput, error)

DeleteStateMachineVersion API operation for AWS Step Functions.

Deletes a state machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html). After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html).

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

You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

Related operations:

  • PublishStateMachineVersion

  • ListStateMachineVersions

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 DeleteStateMachineVersion for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineVersion

func (*SFN) DeleteStateMachineVersionRequest added in v1.42.9

func (c *SFN) DeleteStateMachineVersionRequest(input *DeleteStateMachineVersionInput) (req *request.Request, output *DeleteStateMachineVersionOutput)

DeleteStateMachineVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteStateMachineVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStateMachineVersion for more information on using the DeleteStateMachineVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineVersion

func (*SFN) DeleteStateMachineVersionWithContext added in v1.42.9

func (c *SFN) DeleteStateMachineVersionWithContext(ctx aws.Context, input *DeleteStateMachineVersionInput, opts ...request.Option) (*DeleteStateMachineVersionOutput, error)

DeleteStateMachineVersionWithContext is the same as DeleteStateMachineVersion with the addition of the ability to pass a context and additional request options.

See DeleteStateMachineVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DeleteStateMachineWithContext

func (c *SFN) DeleteStateMachineWithContext(ctx aws.Context, input *DeleteStateMachineInput, opts ...request.Option) (*DeleteStateMachineOutput, error)

DeleteStateMachineWithContext is the same as DeleteStateMachine with the addition of the ability to pass a context and additional request options.

See DeleteStateMachine for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DescribeActivity

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

DescribeActivity API operation for AWS Step Functions.

Describes an activity.

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

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

  • ActivityDoesNotExist The specified activity does not exist.

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

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActivity for more information on using the DescribeActivity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) DescribeActivityWithContext

func (c *SFN) DescribeActivityWithContext(ctx aws.Context, input *DescribeActivityInput, opts ...request.Option) (*DescribeActivityOutput, error)

DescribeActivityWithContext is the same as DescribeActivity with the addition of the ability to pass a context and additional request options.

See DescribeActivity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DescribeExecution

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

DescribeExecution API operation for AWS Step Functions.

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

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

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

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

  • ExecutionDoesNotExist The specified execution does not exist.

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

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExecution for more information on using the DescribeExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) DescribeExecutionWithContext

func (c *SFN) DescribeExecutionWithContext(ctx aws.Context, input *DescribeExecutionInput, opts ...request.Option) (*DescribeExecutionOutput, error)

DescribeExecutionWithContext is the same as DescribeExecution with the addition of the ability to pass a context and additional request options.

See DescribeExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DescribeMapRun added in v1.42.9

func (c *SFN) DescribeMapRun(input *DescribeMapRunInput) (*DescribeMapRunOutput, error)

DescribeMapRun API operation for AWS Step Functions.

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) in the Step Functions Developer Guide.

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 DescribeMapRun for usage and error information.

Returned Error Types:

  • ResourceNotFound Could not find the referenced resource.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeMapRun

func (*SFN) DescribeMapRunRequest added in v1.42.9

func (c *SFN) DescribeMapRunRequest(input *DescribeMapRunInput) (req *request.Request, output *DescribeMapRunOutput)

DescribeMapRunRequest generates a "aws/request.Request" representing the client's request for the DescribeMapRun operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMapRun for more information on using the DescribeMapRun API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeMapRun

func (*SFN) DescribeMapRunWithContext added in v1.42.9

func (c *SFN) DescribeMapRunWithContext(ctx aws.Context, input *DescribeMapRunInput, opts ...request.Option) (*DescribeMapRunOutput, error)

DescribeMapRunWithContext is the same as DescribeMapRun with the addition of the ability to pass a context and additional request options.

See DescribeMapRun for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DescribeStateMachine

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

DescribeStateMachine API operation for AWS Step Functions.

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

  • The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

  • The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.

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

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

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

  • StateMachineDoesNotExist The specified state machine does not exist.

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

func (*SFN) DescribeStateMachineAlias added in v1.42.9

func (c *SFN) DescribeStateMachineAlias(input *DescribeStateMachineAliasInput) (*DescribeStateMachineAliasOutput, error)

DescribeStateMachineAlias API operation for AWS Step Functions.

Returns details about a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html).

Related operations:

  • CreateStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

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 DescribeStateMachineAlias for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

  • ResourceNotFound Could not find the referenced resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineAlias

func (*SFN) DescribeStateMachineAliasRequest added in v1.42.9

func (c *SFN) DescribeStateMachineAliasRequest(input *DescribeStateMachineAliasInput) (req *request.Request, output *DescribeStateMachineAliasOutput)

DescribeStateMachineAliasRequest generates a "aws/request.Request" representing the client's request for the DescribeStateMachineAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStateMachineAlias for more information on using the DescribeStateMachineAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineAlias

func (*SFN) DescribeStateMachineAliasWithContext added in v1.42.9

func (c *SFN) DescribeStateMachineAliasWithContext(ctx aws.Context, input *DescribeStateMachineAliasInput, opts ...request.Option) (*DescribeStateMachineAliasOutput, error)

DescribeStateMachineAliasWithContext is the same as DescribeStateMachineAlias with the addition of the ability to pass a context and additional request options.

See DescribeStateMachineAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) DescribeStateMachineForExecution

func (c *SFN) DescribeStateMachineForExecution(input *DescribeStateMachineForExecutionInput) (*DescribeStateMachineForExecutionOutput, error)

DescribeStateMachineForExecution API operation for AWS Step Functions.

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

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

This API action is not supported by EXPRESS state machines.

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 DescribeStateMachineForExecution for usage and error information.

Returned Error Types:

  • ExecutionDoesNotExist The specified execution does not exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution

func (*SFN) DescribeStateMachineForExecutionRequest

func (c *SFN) DescribeStateMachineForExecutionRequest(input *DescribeStateMachineForExecutionInput) (req *request.Request, output *DescribeStateMachineForExecutionOutput)

DescribeStateMachineForExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeStateMachineForExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStateMachineForExecution for more information on using the DescribeStateMachineForExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution

func (*SFN) DescribeStateMachineForExecutionWithContext

func (c *SFN) DescribeStateMachineForExecutionWithContext(ctx aws.Context, input *DescribeStateMachineForExecutionInput, opts ...request.Option) (*DescribeStateMachineForExecutionOutput, error)

DescribeStateMachineForExecutionWithContext is the same as DescribeStateMachineForExecution with the addition of the ability to pass a context and additional request options.

See DescribeStateMachineForExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStateMachine for more information on using the DescribeStateMachine API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) DescribeStateMachineWithContext

func (c *SFN) DescribeStateMachineWithContext(ctx aws.Context, input *DescribeStateMachineInput, opts ...request.Option) (*DescribeStateMachineOutput, error)

DescribeStateMachineWithContext is the same as DescribeStateMachine with the addition of the ability to pass a context and additional request options.

See DescribeStateMachine for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

This API action isn't logged in CloudTrail.

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

Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks (https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html) in the Step Functions Developer Guide.

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

  • 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 not valid.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetActivityTask for more information on using the GetActivityTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) GetActivityTaskWithContext

func (c *SFN) GetActivityTaskWithContext(ctx aws.Context, input *GetActivityTaskInput, opts ...request.Option) (*GetActivityTaskOutput, error)

GetActivityTaskWithContext is the same as GetActivityTask with the addition of the ability to pass a context and additional request options.

See GetActivityTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

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

  • ExecutionDoesNotExist The specified execution does not exist.

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

  • InvalidToken The provided token is not valid.

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

func (*SFN) GetExecutionHistoryPages

func (c *SFN) GetExecutionHistoryPages(input *GetExecutionHistoryInput, fn func(*GetExecutionHistoryOutput, bool) 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 *sfn.GetExecutionHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) GetExecutionHistoryPagesWithContext

func (c *SFN) GetExecutionHistoryPagesWithContext(ctx aws.Context, input *GetExecutionHistoryInput, fn func(*GetExecutionHistoryOutput, bool) bool, opts ...request.Option) error

GetExecutionHistoryPagesWithContext same as GetExecutionHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetExecutionHistory for more information on using the GetExecutionHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) GetExecutionHistoryWithContext

func (c *SFN) GetExecutionHistoryWithContext(ctx aws.Context, input *GetExecutionHistoryInput, opts ...request.Option) (*GetExecutionHistoryOutput, error)

GetExecutionHistoryWithContext is the same as GetExecutionHistory with the addition of the ability to pass a context and additional request options.

See GetExecutionHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListActivities

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

ListActivities API operation for AWS Step Functions.

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

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

  • InvalidToken The provided token is not valid.

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

func (*SFN) ListActivitiesPages

func (c *SFN) ListActivitiesPages(input *ListActivitiesInput, fn func(*ListActivitiesOutput, bool) 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 *sfn.ListActivitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListActivitiesPagesWithContext

func (c *SFN) ListActivitiesPagesWithContext(ctx aws.Context, input *ListActivitiesInput, fn func(*ListActivitiesOutput, bool) bool, opts ...request.Option) error

ListActivitiesPagesWithContext same as ListActivitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListActivities for more information on using the ListActivities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) ListActivitiesWithContext

func (c *SFN) ListActivitiesWithContext(ctx aws.Context, input *ListActivitiesInput, opts ...request.Option) (*ListActivitiesOutput, error)

ListActivitiesWithContext is the same as ListActivities with the addition of the ability to pass a context and additional request options.

See ListActivities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListExecutions

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

ListExecutions API operation for AWS Step Functions.

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

You can also provide a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) ARN or version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) ARN to list the executions associated with a specific alias or version.

Results are sorted by time, with the most recent execution first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

This API action is not supported by EXPRESS state machines.

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

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

  • InvalidToken The provided token is not valid.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • StateMachineTypeNotSupported

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFound Could not find the referenced resource.

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

func (*SFN) ListExecutionsPages

func (c *SFN) ListExecutionsPages(input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) 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 *sfn.ListExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListExecutionsPagesWithContext

func (c *SFN) ListExecutionsPagesWithContext(ctx aws.Context, input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) bool, opts ...request.Option) error

ListExecutionsPagesWithContext same as ListExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExecutions for more information on using the ListExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) ListExecutionsWithContext

func (c *SFN) ListExecutionsWithContext(ctx aws.Context, input *ListExecutionsInput, opts ...request.Option) (*ListExecutionsOutput, error)

ListExecutionsWithContext is the same as ListExecutions with the addition of the ability to pass a context and additional request options.

See ListExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListMapRuns added in v1.42.9

func (c *SFN) ListMapRuns(input *ListMapRunsInput) (*ListMapRunsOutput, error)

ListMapRuns API operation for AWS Step Functions.

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

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 ListMapRuns for usage and error information.

Returned Error Types:

  • ExecutionDoesNotExist The specified execution does not exist.

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

  • InvalidToken The provided token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListMapRuns

func (*SFN) ListMapRunsPages added in v1.42.9

func (c *SFN) ListMapRunsPages(input *ListMapRunsInput, fn func(*ListMapRunsOutput, bool) bool) error

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

See ListMapRuns 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 ListMapRuns operation.
pageNum := 0
err := client.ListMapRunsPages(params,
    func(page *sfn.ListMapRunsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListMapRunsPagesWithContext added in v1.42.9

func (c *SFN) ListMapRunsPagesWithContext(ctx aws.Context, input *ListMapRunsInput, fn func(*ListMapRunsOutput, bool) bool, opts ...request.Option) error

ListMapRunsPagesWithContext same as ListMapRunsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListMapRunsRequest added in v1.42.9

func (c *SFN) ListMapRunsRequest(input *ListMapRunsInput) (req *request.Request, output *ListMapRunsOutput)

ListMapRunsRequest generates a "aws/request.Request" representing the client's request for the ListMapRuns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMapRuns for more information on using the ListMapRuns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListMapRuns

func (*SFN) ListMapRunsWithContext added in v1.42.9

func (c *SFN) ListMapRunsWithContext(ctx aws.Context, input *ListMapRunsInput, opts ...request.Option) (*ListMapRunsOutput, error)

ListMapRunsWithContext is the same as ListMapRuns with the addition of the ability to pass a context and additional request options.

See ListMapRuns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListStateMachineAliases added in v1.42.9

func (c *SFN) ListStateMachineAliases(input *ListStateMachineAliasesInput) (*ListStateMachineAliasesOutput, error)

ListStateMachineAliases API operation for AWS Step Functions.

Lists aliases (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html), you can specify the version ARN in the stateMachineArn parameter.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

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 ListStateMachineAliases for usage and error information.

Returned Error Types:

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

  • InvalidToken The provided token is not valid.

  • ResourceNotFound Could not find the referenced resource.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • StateMachineDeleting The specified state machine is being deleted.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachineAliases

func (*SFN) ListStateMachineAliasesRequest added in v1.42.9

func (c *SFN) ListStateMachineAliasesRequest(input *ListStateMachineAliasesInput) (req *request.Request, output *ListStateMachineAliasesOutput)

ListStateMachineAliasesRequest generates a "aws/request.Request" representing the client's request for the ListStateMachineAliases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStateMachineAliases for more information on using the ListStateMachineAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachineAliases

func (*SFN) ListStateMachineAliasesWithContext added in v1.42.9

func (c *SFN) ListStateMachineAliasesWithContext(ctx aws.Context, input *ListStateMachineAliasesInput, opts ...request.Option) (*ListStateMachineAliasesOutput, error)

ListStateMachineAliasesWithContext is the same as ListStateMachineAliases with the addition of the ability to pass a context and additional request options.

See ListStateMachineAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListStateMachineVersions added in v1.42.9

func (c *SFN) ListStateMachineVersions(input *ListStateMachineVersionsInput) (*ListStateMachineVersionsOutput, error)

ListStateMachineVersions API operation for AWS Step Functions.

Lists versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

  • PublishStateMachineVersion

  • DeleteStateMachineVersion

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 ListStateMachineVersions for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

  • InvalidToken The provided token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachineVersions

func (*SFN) ListStateMachineVersionsRequest added in v1.42.9

func (c *SFN) ListStateMachineVersionsRequest(input *ListStateMachineVersionsInput) (req *request.Request, output *ListStateMachineVersionsOutput)

ListStateMachineVersionsRequest generates a "aws/request.Request" representing the client's request for the ListStateMachineVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStateMachineVersions for more information on using the ListStateMachineVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachineVersions

func (*SFN) ListStateMachineVersionsWithContext added in v1.42.9

func (c *SFN) ListStateMachineVersionsWithContext(ctx aws.Context, input *ListStateMachineVersionsInput, opts ...request.Option) (*ListStateMachineVersionsOutput, error)

ListStateMachineVersionsWithContext is the same as ListStateMachineVersions with the addition of the ability to pass a context and additional request options.

See ListStateMachineVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListStateMachines

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

ListStateMachines API operation for AWS Step Functions.

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

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

  • InvalidToken The provided token is not valid.

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

func (*SFN) ListStateMachinesPages

func (c *SFN) ListStateMachinesPages(input *ListStateMachinesInput, fn func(*ListStateMachinesOutput, bool) 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 *sfn.ListStateMachinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SFN) ListStateMachinesPagesWithContext

func (c *SFN) ListStateMachinesPagesWithContext(ctx aws.Context, input *ListStateMachinesInput, fn func(*ListStateMachinesOutput, bool) bool, opts ...request.Option) error

ListStateMachinesPagesWithContext same as ListStateMachinesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStateMachines for more information on using the ListStateMachines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) ListStateMachinesWithContext

func (c *SFN) ListStateMachinesWithContext(ctx aws.Context, input *ListStateMachinesInput, opts ...request.Option) (*ListStateMachinesOutput, error)

ListStateMachinesWithContext is the same as ListStateMachines with the addition of the ability to pass a context and additional request options.

See ListStateMachines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) ListTagsForResource

func (c *SFN) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Step Functions.

List tags for a given resource.

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

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 ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFound Could not find the referenced resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListTagsForResource

func (*SFN) ListTagsForResourceRequest

func (c *SFN) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListTagsForResource

func (*SFN) ListTagsForResourceWithContext

func (c *SFN) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) PublishStateMachineVersion added in v1.42.9

func (c *SFN) PublishStateMachineVersion(input *PublishStateMachineVersionInput) (*PublishStateMachineVersionOutput, error)

PublishStateMachineVersion API operation for AWS Step Functions.

Creates a version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.

Related operations:

  • DeleteStateMachineVersion

  • ListStateMachineVersions

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 PublishStateMachineVersion for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

  • StateMachineDeleting The specified state machine is being deleted.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

    HTTP Status Code: 402

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/PublishStateMachineVersion

func (*SFN) PublishStateMachineVersionRequest added in v1.42.9

func (c *SFN) PublishStateMachineVersionRequest(input *PublishStateMachineVersionInput) (req *request.Request, output *PublishStateMachineVersionOutput)

PublishStateMachineVersionRequest generates a "aws/request.Request" representing the client's request for the PublishStateMachineVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PublishStateMachineVersion for more information on using the PublishStateMachineVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/PublishStateMachineVersion

func (*SFN) PublishStateMachineVersionWithContext added in v1.42.9

func (c *SFN) PublishStateMachineVersionWithContext(ctx aws.Context, input *PublishStateMachineVersionInput, opts ...request.Option) (*PublishStateMachineVersionOutput, error)

PublishStateMachineVersionWithContext is the same as PublishStateMachineVersion with the addition of the ability to pass a context and additional request options.

See PublishStateMachineVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) SendTaskFailure

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

SendTaskFailure API operation for AWS Step Functions.

Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken failed.

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 SendTaskFailure for usage and error information.

Returned Error Types:

  • TaskDoesNotExist

  • InvalidToken The provided token is not valid.

  • TaskTimedOut

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendTaskFailure for more information on using the SendTaskFailure API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) SendTaskFailureWithContext

func (c *SFN) SendTaskFailureWithContext(ctx aws.Context, input *SendTaskFailureInput, opts ...request.Option) (*SendTaskFailureOutput, error)

SendTaskFailureWithContext is the same as SendTaskFailure with the addition of the ability to pass a context and additional request options.

See SendTaskFailure for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) SendTaskHeartbeat

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

SendTaskHeartbeat API operation for AWS Step Functions.

Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) or callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

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 SendTaskHeartbeat for usage and error information.

Returned Error Types:

  • TaskDoesNotExist

  • InvalidToken The provided token is not valid.

  • TaskTimedOut

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendTaskHeartbeat for more information on using the SendTaskHeartbeat API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) SendTaskHeartbeatWithContext

func (c *SFN) SendTaskHeartbeatWithContext(ctx aws.Context, input *SendTaskHeartbeatInput, opts ...request.Option) (*SendTaskHeartbeatOutput, error)

SendTaskHeartbeatWithContext is the same as SendTaskHeartbeat with the addition of the ability to pass a context and additional request options.

See SendTaskHeartbeat for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) SendTaskSuccess

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

SendTaskSuccess API operation for AWS Step Functions.

Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) pattern to report that the task identified by the taskToken completed successfully.

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 SendTaskSuccess for usage and error information.

Returned Error Types:

  • TaskDoesNotExist

  • InvalidOutput The provided JSON output data is not valid.

  • InvalidToken The provided token is not valid.

  • TaskTimedOut

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendTaskSuccess for more information on using the SendTaskSuccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) SendTaskSuccessWithContext

func (c *SFN) SendTaskSuccessWithContext(ctx aws.Context, input *SendTaskSuccessInput, opts ...request.Option) (*SendTaskSuccessOutput, error)

SendTaskSuccessWithContext is the same as SendTaskSuccess with the addition of the ability to pass a context and additional request options.

See SendTaskSuccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) StartExecution

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

StartExecution API operation for AWS Step Functions.

Starts a state machine execution.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

  • The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

  • The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

To start executions of a state machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html), call StartExecution and provide the version ARN or the ARN of an alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) that points to the version.

StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

StartExecution isn't idempotent for EXPRESS workflows.

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

  • 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 The execution has the same name as another execution (but a different input).

    Executions with the same name and input are considered idempotent.

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

  • InvalidExecutionInput The provided JSON input data is not valid.

  • InvalidName The provided name is not valid.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • StateMachineDeleting The specified state machine is being deleted.

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartExecution for more information on using the StartExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) StartExecutionWithContext

func (c *SFN) StartExecutionWithContext(ctx aws.Context, input *StartExecutionInput, opts ...request.Option) (*StartExecutionOutput, error)

StartExecutionWithContext is the same as StartExecution with the addition of the ability to pass a context and additional request options.

See StartExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) StartSyncExecution

func (c *SFN) StartSyncExecution(input *StartSyncExecutionInput) (*StartSyncExecutionOutput, error)

StartSyncExecution API operation for AWS Step Functions.

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

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn't logged in CloudTrail.

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 StartSyncExecution for usage and error information.

Returned Error Types:

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

  • InvalidExecutionInput The provided JSON input data is not valid.

  • InvalidName The provided name is not valid.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • StateMachineDeleting The specified state machine is being deleted.

  • StateMachineTypeNotSupported

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartSyncExecution

func (*SFN) StartSyncExecutionRequest

func (c *SFN) StartSyncExecutionRequest(input *StartSyncExecutionInput) (req *request.Request, output *StartSyncExecutionOutput)

StartSyncExecutionRequest generates a "aws/request.Request" representing the client's request for the StartSyncExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSyncExecution for more information on using the StartSyncExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartSyncExecution

func (*SFN) StartSyncExecutionWithContext

func (c *SFN) StartSyncExecutionWithContext(ctx aws.Context, input *StartSyncExecutionInput, opts ...request.Option) (*StartSyncExecutionOutput, error)

StartSyncExecutionWithContext is the same as StartSyncExecution with the addition of the ability to pass a context and additional request options.

See StartSyncExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) StopExecution

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

StopExecution API operation for AWS Step Functions.

Stops an execution.

This API action is not supported by EXPRESS state machines.

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

  • ExecutionDoesNotExist The specified execution does not exist.

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

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopExecution for more information on using the StopExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

func (*SFN) StopExecutionWithContext

func (c *SFN) StopExecutionWithContext(ctx aws.Context, input *StopExecutionInput, opts ...request.Option) (*StopExecutionOutput, error)

StopExecutionWithContext is the same as StopExecution with the addition of the ability to pass a context and additional request options.

See StopExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) TagResource

func (c *SFN) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Step Functions.

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).

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

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 TagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFound Could not find the referenced resource.

  • TooManyTags You've exceeded the number of tags allowed for a resource. See the Limits Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) in the Step Functions Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TagResource

func (*SFN) TagResourceRequest

func (c *SFN) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TagResource

func (*SFN) TagResourceWithContext

func (c *SFN) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) UntagResource

func (c *SFN) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Step Functions.

Remove a tag from a Step Functions resource

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 UntagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFound Could not find the referenced resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UntagResource

func (*SFN) UntagResourceRequest

func (c *SFN) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UntagResource

func (*SFN) UntagResourceWithContext

func (c *SFN) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) UpdateMapRun added in v1.42.9

func (c *SFN) UpdateMapRun(input *UpdateMapRunInput) (*UpdateMapRunOutput, error)

UpdateMapRun API operation for AWS Step Functions.

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

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 UpdateMapRun for usage and error information.

Returned Error Types:

  • ResourceNotFound Could not find the referenced resource.

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

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateMapRun

func (*SFN) UpdateMapRunRequest added in v1.42.9

func (c *SFN) UpdateMapRunRequest(input *UpdateMapRunInput) (req *request.Request, output *UpdateMapRunOutput)

UpdateMapRunRequest generates a "aws/request.Request" representing the client's request for the UpdateMapRun operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMapRun for more information on using the UpdateMapRun API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateMapRun

func (*SFN) UpdateMapRunWithContext added in v1.42.9

func (c *SFN) UpdateMapRunWithContext(ctx aws.Context, input *UpdateMapRunInput, opts ...request.Option) (*UpdateMapRunOutput, error)

UpdateMapRunWithContext is the same as UpdateMapRun with the addition of the ability to pass a context and additional request options.

See UpdateMapRun for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) UpdateStateMachine

func (c *SFN) UpdateStateMachine(input *UpdateStateMachineInput) (*UpdateStateMachineOutput, error)

UpdateStateMachine API operation for AWS Step Functions.

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

  • The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

  • The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html). This way, you can opt-in to strict versioning of your state machine.

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

All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

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 UpdateStateMachine for usage and error information.

Returned Error Types:

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

  • InvalidDefinition The provided Amazon States Language definition is not valid.

  • InvalidLoggingConfiguration

  • InvalidTracingConfiguration Your tracingConfiguration key does not match, or enabled has not been set to true or false.

  • MissingRequiredParameter Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

  • StateMachineDeleting The specified state machine is being deleted.

  • StateMachineDoesNotExist The specified state machine does not exist.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

    HTTP Status Code: 402

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachine

func (*SFN) UpdateStateMachineAlias added in v1.42.9

func (c *SFN) UpdateStateMachineAlias(input *UpdateStateMachineAliasInput) (*UpdateStateMachineAliasOutput, error)

UpdateStateMachineAlias API operation for AWS Step Functions.

Updates the configuration of an existing state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response.

This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.

Related operations:

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • DeleteStateMachineAlias

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 UpdateStateMachineAlias for usage and error information.

Returned Error Types:

  • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.

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

  • ResourceNotFound Could not find the referenced resource.

  • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

    HTTP Status Code: 409

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineAlias

func (*SFN) UpdateStateMachineAliasRequest added in v1.42.9

func (c *SFN) UpdateStateMachineAliasRequest(input *UpdateStateMachineAliasInput) (req *request.Request, output *UpdateStateMachineAliasOutput)

UpdateStateMachineAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateStateMachineAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStateMachineAlias for more information on using the UpdateStateMachineAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineAlias

func (*SFN) UpdateStateMachineAliasWithContext added in v1.42.9

func (c *SFN) UpdateStateMachineAliasWithContext(ctx aws.Context, input *UpdateStateMachineAliasInput, opts ...request.Option) (*UpdateStateMachineAliasOutput, error)

UpdateStateMachineAliasWithContext is the same as UpdateStateMachineAlias with the addition of the ability to pass a context and additional request options.

See UpdateStateMachineAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SFN) UpdateStateMachineRequest

func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) (req *request.Request, output *UpdateStateMachineOutput)

UpdateStateMachineRequest generates a "aws/request.Request" representing the client's request for the UpdateStateMachine operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStateMachine for more information on using the UpdateStateMachine API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachine

func (*SFN) UpdateStateMachineWithContext

func (c *SFN) UpdateStateMachineWithContext(ctx aws.Context, input *UpdateStateMachineInput, opts ...request.Option) (*UpdateStateMachineOutput, error)

UpdateStateMachineWithContext is the same as UpdateStateMachine with the addition of the ability to pass a context and additional request options.

See UpdateStateMachine for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SendTaskFailureInput

type SendTaskFailureInput struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendTaskFailureInput's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendTaskFailureInput's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The token that represents this task. Task tokens are generated by Step Functions
	// when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html)
	// when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendTaskFailureInput) GoString

func (s SendTaskFailureInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendTaskFailureInput) Validate

func (s *SendTaskFailureInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendTaskFailureOutput

type SendTaskFailureOutput struct {
	// contains filtered or unexported fields
}

func (SendTaskFailureOutput) GoString

func (s SendTaskFailureOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SendTaskFailureOutput) String

func (s SendTaskFailureOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendTaskHeartbeatInput

type SendTaskHeartbeatInput struct {

	// The token that represents this task. Task tokens are generated by Step Functions
	// when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html)
	// when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendTaskHeartbeatInput) GoString

func (s SendTaskHeartbeatInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendTaskHeartbeatInput) SetTaskToken

SetTaskToken sets the TaskToken field's value.

func (SendTaskHeartbeatInput) String

func (s SendTaskHeartbeatInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendTaskHeartbeatInput) Validate

func (s *SendTaskHeartbeatInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendTaskHeartbeatOutput

type SendTaskHeartbeatOutput struct {
	// contains filtered or unexported fields
}

func (SendTaskHeartbeatOutput) GoString

func (s SendTaskHeartbeatOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SendTaskHeartbeatOutput) String

func (s SendTaskHeartbeatOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendTaskSuccessInput

type SendTaskSuccessInput struct {

	// The JSON output of the task. Length constraints apply to the payload size,
	// and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendTaskSuccessInput's
	// String and GoString methods.
	//
	// Output is a required field
	Output *string `locationName:"output" type:"string" required:"true" sensitive:"true"`

	// The token that represents this task. Task tokens are generated by Step Functions
	// when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html)
	// when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendTaskSuccessInput) GoString

func (s SendTaskSuccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendTaskSuccessInput) Validate

func (s *SendTaskSuccessInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendTaskSuccessOutput

type SendTaskSuccessOutput struct {
	// contains filtered or unexported fields
}

func (SendTaskSuccessOutput) GoString

func (s SendTaskSuccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SendTaskSuccessOutput) String

func (s SendTaskSuccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException added in v1.42.9

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

func (*ServiceQuotaExceededException) Code added in v1.42.9

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.42.9

func (ServiceQuotaExceededException) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.42.9

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.42.9

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.42.9

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.42.9

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartExecutionInput

type StartExecutionInput struct {

	// The string that contains the JSON input data for the execution, for example:
	//
	// "input": "{\"first_name\" : \"test\"}"
	//
	// If you don't include any JSON input data, you still must include the two
	// braces, for example: "input": "{}"
	//
	// Length constraints apply to the payload size, and are expressed as bytes
	// in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartExecutionInput's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Optional name of the execution. This name must be unique for your Amazon
	// Web Services account, Region, and state machine for 90 days. For more information,
	// see Limits Related to State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions)
	// in the Step Functions Developer Guide.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine to execute.
	//
	// The stateMachineArn parameter accepts one of the following inputs:
	//
	//    * An unqualified state machine ARN – Refers to a state machine ARN that
	//    isn't qualified with a version or alias ARN. The following is an example
	//    of an unqualified state machine ARN. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
	//    Step Functions doesn't associate state machine executions that you start
	//    with an unqualified ARN with a version. This is true even if that version
	//    uses the same revision that the execution used.
	//
	//    * A state machine version ARN – Refers to a version ARN, which is a
	//    combination of state machine ARN and the version number separated by a
	//    colon (:). The following is an example of the ARN for version 10. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10
	//    Step Functions doesn't associate executions that you start with a version
	//    ARN with any aliases that point to that version.
	//
	//    * A state machine alias ARN – Refers to an alias ARN, which is a combination
	//    of state machine ARN and the alias name separated by a colon (:). The
	//    following is an example of the ARN for an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
	//    Step Functions associates executions that you start with an alias ARN
	//    with that alias and the state machine version used for that execution.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// Passes the X-Ray trace header. The trace header can also be passed in the
	// request payload.
	TraceHeader *string `locationName:"traceHeader" type:"string"`
	// contains filtered or unexported fields
}

func (StartExecutionInput) GoString

func (s StartExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTraceHeader

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

SetTraceHeader sets the TraceHeader field's value.

func (StartExecutionInput) String

func (s StartExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExecutionInput) Validate

func (s *StartExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartExecutionOutput

type StartExecutionOutput struct {

	// The Amazon Resource Name (ARN) that identifies the execution.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// The date the execution is started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (StartExecutionOutput) GoString

func (s StartExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSyncExecutionInput

type StartSyncExecutionInput struct {

	// The string that contains the JSON input data for the execution, for example:
	//
	// "input": "{\"first_name\" : \"test\"}"
	//
	// If you don't include any JSON input data, you still must include the two
	// braces, for example: "input": "{}"
	//
	// Length constraints apply to the payload size, and are expressed as bytes
	// in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSyncExecutionInput's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// The name of the execution.
	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"`

	// Passes the X-Ray trace header. The trace header can also be passed in the
	// request payload.
	TraceHeader *string `locationName:"traceHeader" type:"string"`
	// contains filtered or unexported fields
}

func (StartSyncExecutionInput) GoString

func (s StartSyncExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSyncExecutionInput) SetInput

SetInput sets the Input field's value.

func (*StartSyncExecutionInput) SetName

SetName sets the Name field's value.

func (*StartSyncExecutionInput) SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*StartSyncExecutionInput) SetTraceHeader

SetTraceHeader sets the TraceHeader field's value.

func (StartSyncExecutionInput) String

func (s StartSyncExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSyncExecutionInput) Validate

func (s *StartSyncExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSyncExecutionOutput

type StartSyncExecutionOutput struct {

	// An object that describes workflow billing details, including billed duration
	// and memory use.
	BillingDetails *BillingDetails `locationName:"billingDetails" type:"structure"`

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSyncExecutionOutput's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSyncExecutionOutput's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) that identifies the execution.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`

	// The string that contains the JSON input data of the execution. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSyncExecutionOutput's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Provides details about execution input or output.
	InputDetails *CloudWatchEventsExecutionDataDetails `locationName:"inputDetails" type:"structure"`

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

	// The JSON output data of the execution. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// This field is set only if the execution succeeds. If the execution fails,
	// this field is null.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSyncExecutionOutput's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Provides details about execution input or output.
	OutputDetails *CloudWatchEventsExecutionDataDetails `locationName:"outputDetails" type:"structure"`

	// The date the execution is started.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) that identifies the state machine.
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string"`

	// The current status of the execution.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"SyncExecutionStatus"`

	// If the execution has already ended, the date the execution stopped.
	//
	// StopDate is a required field
	StopDate *time.Time `locationName:"stopDate" type:"timestamp" required:"true"`

	// The X-Ray trace header that was passed to the execution.
	TraceHeader *string `locationName:"traceHeader" type:"string"`
	// contains filtered or unexported fields
}

func (StartSyncExecutionOutput) GoString

func (s StartSyncExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSyncExecutionOutput) SetBillingDetails

SetBillingDetails sets the BillingDetails field's value.

func (*StartSyncExecutionOutput) SetCause

SetCause sets the Cause field's value.

func (*StartSyncExecutionOutput) SetError

SetError sets the Error field's value.

func (*StartSyncExecutionOutput) SetExecutionArn

SetExecutionArn sets the ExecutionArn field's value.

func (*StartSyncExecutionOutput) SetInput

SetInput sets the Input field's value.

func (*StartSyncExecutionOutput) SetInputDetails

SetInputDetails sets the InputDetails field's value.

func (*StartSyncExecutionOutput) SetName

SetName sets the Name field's value.

func (*StartSyncExecutionOutput) SetOutput

SetOutput sets the Output field's value.

func (*StartSyncExecutionOutput) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (*StartSyncExecutionOutput) SetStartDate

SetStartDate sets the StartDate field's value.

func (*StartSyncExecutionOutput) SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*StartSyncExecutionOutput) SetStatus

SetStatus sets the Status field's value.

func (*StartSyncExecutionOutput) SetStopDate

SetStopDate sets the StopDate field's value.

func (*StartSyncExecutionOutput) SetTraceHeader

SetTraceHeader sets the TraceHeader field's value.

func (StartSyncExecutionOutput) String

func (s StartSyncExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateEnteredEventDetails

type StateEnteredEventDetails struct {

	// The string that contains the JSON input data for the state. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StateEnteredEventDetails's
	// String and GoString methods.
	Input *string `locationName:"input" type:"string" sensitive:"true"`

	// Contains details about the input for an execution history event.
	InputDetails *HistoryEventExecutionDataDetails `locationName:"inputDetails" type:"structure"`

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

Contains details about a state entered during an execution.

func (StateEnteredEventDetails) GoString

func (s StateEnteredEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateEnteredEventDetails) SetInput

SetInput sets the Input field's value.

func (*StateEnteredEventDetails) SetInputDetails

SetInputDetails sets the InputDetails 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateExitedEventDetails

type StateExitedEventDetails struct {

	// The name of the state.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The JSON output data of the state. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StateExitedEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about an exit from a state during an execution.

func (StateExitedEventDetails) GoString

func (s StateExitedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateExitedEventDetails) SetName

SetName sets the Name field's value.

func (*StateExitedEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*StateExitedEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (StateExitedEventDetails) String

func (s StateExitedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineAliasListItem added in v1.42.9

type StateMachineAliasListItem struct {

	// The creation date of a state machine alias.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) that identifies a state machine alias. The
	// alias ARN is a combination of state machine ARN and the alias name separated
	// by a colon (:). For example, stateMachineARN:PROD.
	//
	// StateMachineAliasArn is a required field
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a specific state machine alias.

func (StateMachineAliasListItem) GoString added in v1.42.9

func (s StateMachineAliasListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineAliasListItem) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*StateMachineAliasListItem) SetStateMachineAliasArn added in v1.42.9

func (s *StateMachineAliasListItem) SetStateMachineAliasArn(v string) *StateMachineAliasListItem

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (StateMachineAliasListItem) String added in v1.42.9

func (s StateMachineAliasListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineAlreadyExists

type StateMachineAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*StateMachineAlreadyExists) Code

Code returns the exception type name.

func (*StateMachineAlreadyExists) Error

func (s *StateMachineAlreadyExists) Error() string

func (StateMachineAlreadyExists) GoString

func (s StateMachineAlreadyExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineAlreadyExists) Message

func (s *StateMachineAlreadyExists) Message() string

Message returns the exception's message.

func (*StateMachineAlreadyExists) OrigErr

func (s *StateMachineAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StateMachineAlreadyExists) RequestID

func (s *StateMachineAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StateMachineAlreadyExists) StatusCode

func (s *StateMachineAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StateMachineAlreadyExists) String

func (s StateMachineAlreadyExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineDeleting

type StateMachineDeleting struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified state machine is being deleted.

func (*StateMachineDeleting) Code

func (s *StateMachineDeleting) Code() string

Code returns the exception type name.

func (*StateMachineDeleting) Error

func (s *StateMachineDeleting) Error() string

func (StateMachineDeleting) GoString

func (s StateMachineDeleting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineDeleting) Message

func (s *StateMachineDeleting) Message() string

Message returns the exception's message.

func (*StateMachineDeleting) OrigErr

func (s *StateMachineDeleting) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StateMachineDeleting) RequestID

func (s *StateMachineDeleting) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StateMachineDeleting) StatusCode

func (s *StateMachineDeleting) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StateMachineDeleting) String

func (s StateMachineDeleting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineDoesNotExist

type StateMachineDoesNotExist struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified state machine does not exist.

func (*StateMachineDoesNotExist) Code

func (s *StateMachineDoesNotExist) Code() string

Code returns the exception type name.

func (*StateMachineDoesNotExist) Error

func (s *StateMachineDoesNotExist) Error() string

func (StateMachineDoesNotExist) GoString

func (s StateMachineDoesNotExist) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineDoesNotExist) Message

func (s *StateMachineDoesNotExist) Message() string

Message returns the exception's message.

func (*StateMachineDoesNotExist) OrigErr

func (s *StateMachineDoesNotExist) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StateMachineDoesNotExist) RequestID

func (s *StateMachineDoesNotExist) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StateMachineDoesNotExist) StatusCode

func (s *StateMachineDoesNotExist) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StateMachineDoesNotExist) String

func (s StateMachineDoesNotExist) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineLimitExceeded

type StateMachineLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*StateMachineLimitExceeded) Code

Code returns the exception type name.

func (*StateMachineLimitExceeded) Error

func (s *StateMachineLimitExceeded) Error() string

func (StateMachineLimitExceeded) GoString

func (s StateMachineLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineLimitExceeded) Message

func (s *StateMachineLimitExceeded) Message() string

Message returns the exception's message.

func (*StateMachineLimitExceeded) OrigErr

func (s *StateMachineLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StateMachineLimitExceeded) RequestID

func (s *StateMachineLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StateMachineLimitExceeded) StatusCode

func (s *StateMachineLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StateMachineLimitExceeded) String

func (s StateMachineLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineListItem

type StateMachineListItem struct {

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

	// The name of the state machine.
	//
	// A name must not contain:
	//
	//    * white space
	//
	//    * brackets < > { } [ ]
	//
	//    * wildcard characters ? *
	//
	//    * special characters " # % \ ^ | ~ ` $ & , ; : /
	//
	//    * control characters (U+0000-001F, U+007F-009F)
	//
	// To enable logging with CloudWatch Logs, the name should only contain 0-9,
	// A-Z, a-z, - and _.
	//
	// 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"`

	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"StateMachineType"`
	// contains filtered or unexported fields
}

Contains details about the state machine.

func (StateMachineListItem) GoString

func (s StateMachineListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetType

SetType sets the Type field's value.

func (StateMachineListItem) String

func (s StateMachineListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineTypeNotSupported

type StateMachineTypeNotSupported struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*StateMachineTypeNotSupported) Code

Code returns the exception type name.

func (*StateMachineTypeNotSupported) Error

func (StateMachineTypeNotSupported) GoString

func (s StateMachineTypeNotSupported) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineTypeNotSupported) Message

func (s *StateMachineTypeNotSupported) Message() string

Message returns the exception's message.

func (*StateMachineTypeNotSupported) OrigErr

func (s *StateMachineTypeNotSupported) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StateMachineTypeNotSupported) RequestID

func (s *StateMachineTypeNotSupported) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StateMachineTypeNotSupported) StatusCode

func (s *StateMachineTypeNotSupported) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StateMachineTypeNotSupported) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StateMachineVersionListItem added in v1.42.9

type StateMachineVersionListItem struct {

	// The creation date of a state machine version.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) that identifies a state machine version. The
	// version ARN is a combination of state machine ARN and the version number
	// separated by a colon (:). For example, stateMachineARN:1.
	//
	// StateMachineVersionArn is a required field
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a specific state machine version.

func (StateMachineVersionListItem) GoString added in v1.42.9

func (s StateMachineVersionListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StateMachineVersionListItem) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*StateMachineVersionListItem) SetStateMachineVersionArn added in v1.42.9

func (s *StateMachineVersionListItem) SetStateMachineVersionArn(v string) *StateMachineVersionListItem

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (StateMachineVersionListItem) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopExecutionInput

type StopExecutionInput struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StopExecutionInput's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StopExecutionInput's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the execution to stop.
	//
	// ExecutionArn is a required field
	ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopExecutionInput) GoString

func (s StopExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopExecutionInput) Validate

func (s *StopExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopExecutionOutput

type StopExecutionOutput struct {

	// The date the execution is stopped.
	//
	// StopDate is a required field
	StopDate *time.Time `locationName:"stopDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (StopExecutionOutput) GoString

func (s StopExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// The key of a tag.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The value of a tag.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Tags are key-value pairs that can be associated with Step Functions state machines and activities.

An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).

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

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The list of tags to add to a resource.
	//
	// Tags may only contain Unicode letters, digits, white space, or these symbols:
	// _ . : / = + - @.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskCredentials added in v1.42.9

type TaskCredentials struct {

	// The ARN of an IAM role that Step Functions assumes for the task. The role
	// can allow cross-account access to resources.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the credentials that Step Functions uses for a task.

func (TaskCredentials) GoString added in v1.42.9

func (s TaskCredentials) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskCredentials) SetRoleArn added in v1.42.9

func (s *TaskCredentials) SetRoleArn(v string) *TaskCredentials

SetRoleArn sets the RoleArn field's value.

func (TaskCredentials) String added in v1.42.9

func (s TaskCredentials) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskDoesNotExist

type TaskDoesNotExist struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*TaskDoesNotExist) Code

func (s *TaskDoesNotExist) Code() string

Code returns the exception type name.

func (*TaskDoesNotExist) Error

func (s *TaskDoesNotExist) Error() string

func (TaskDoesNotExist) GoString

func (s TaskDoesNotExist) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskDoesNotExist) Message

func (s *TaskDoesNotExist) Message() string

Message returns the exception's message.

func (*TaskDoesNotExist) OrigErr

func (s *TaskDoesNotExist) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TaskDoesNotExist) RequestID

func (s *TaskDoesNotExist) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TaskDoesNotExist) StatusCode

func (s *TaskDoesNotExist) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TaskDoesNotExist) String

func (s TaskDoesNotExist) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskFailedEventDetails

type TaskFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a task failure event.

func (TaskFailedEventDetails) GoString

func (s TaskFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*TaskFailedEventDetails) SetError

SetError sets the Error field's value.

func (*TaskFailedEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskFailedEventDetails) SetResourceType

func (s *TaskFailedEventDetails) SetResourceType(v string) *TaskFailedEventDetails

SetResourceType sets the ResourceType field's value.

func (TaskFailedEventDetails) String

func (s TaskFailedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskScheduledEventDetails

type TaskScheduledEventDetails struct {

	// The maximum allowed duration between two heartbeats for the task.
	HeartbeatInSeconds *int64 `locationName:"heartbeatInSeconds" type:"long"`

	// The JSON data passed to the resource referenced in a task state. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Parameters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskScheduledEventDetails's
	// String and GoString methods.
	//
	// Parameters is a required field
	Parameters *string `locationName:"parameters" type:"string" required:"true" sensitive:"true"`

	// The region of the scheduled task
	//
	// Region is a required field
	Region *string `locationName:"region" min:"1" type:"string" required:"true"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`

	// The credentials that Step Functions uses for the task.
	TaskCredentials *TaskCredentials `locationName:"taskCredentials" type:"structure"`

	// The maximum allowed duration of the task.
	TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"`
	// contains filtered or unexported fields
}

Contains details about a task scheduled during an execution.

func (TaskScheduledEventDetails) GoString

func (s TaskScheduledEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskScheduledEventDetails) SetHeartbeatInSeconds

func (s *TaskScheduledEventDetails) SetHeartbeatInSeconds(v int64) *TaskScheduledEventDetails

SetHeartbeatInSeconds sets the HeartbeatInSeconds field's value.

func (*TaskScheduledEventDetails) SetParameters

SetParameters sets the Parameters field's value.

func (*TaskScheduledEventDetails) SetRegion

SetRegion sets the Region field's value.

func (*TaskScheduledEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskScheduledEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (*TaskScheduledEventDetails) SetTaskCredentials added in v1.42.9

SetTaskCredentials sets the TaskCredentials field's value.

func (*TaskScheduledEventDetails) SetTimeoutInSeconds

func (s *TaskScheduledEventDetails) SetTimeoutInSeconds(v int64) *TaskScheduledEventDetails

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (TaskScheduledEventDetails) String

func (s TaskScheduledEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskStartFailedEventDetails

type TaskStartFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskStartFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskStartFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a task that failed to start during an execution.

func (TaskStartFailedEventDetails) GoString

func (s TaskStartFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskStartFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*TaskStartFailedEventDetails) SetError

SetError sets the Error field's value.

func (*TaskStartFailedEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskStartFailedEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskStartFailedEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskStartedEventDetails

type TaskStartedEventDetails struct {

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the start of a task during an execution.

func (TaskStartedEventDetails) GoString

func (s TaskStartedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskStartedEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskStartedEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskStartedEventDetails) String

func (s TaskStartedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskSubmitFailedEventDetails

type TaskSubmitFailedEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskSubmitFailedEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskSubmitFailedEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a task that failed to submit during an execution.

func (TaskSubmitFailedEventDetails) GoString

func (s TaskSubmitFailedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSubmitFailedEventDetails) SetCause

SetCause sets the Cause field's value.

func (*TaskSubmitFailedEventDetails) SetError

SetError sets the Error field's value.

func (*TaskSubmitFailedEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskSubmitFailedEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskSubmitFailedEventDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskSubmittedEventDetails

type TaskSubmittedEventDetails struct {

	// The response from a resource when a task has started. Length constraints
	// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskSubmittedEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a task submitted to a resource .

func (TaskSubmittedEventDetails) GoString

func (s TaskSubmittedEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSubmittedEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*TaskSubmittedEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (*TaskSubmittedEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskSubmittedEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskSubmittedEventDetails) String

func (s TaskSubmittedEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskSucceededEventDetails

type TaskSucceededEventDetails struct {

	// The full JSON response from a resource when a task has succeeded. This response
	// becomes the output of the related task. Length constraints apply to the payload
	// size, and are expressed as bytes in UTF-8 encoding.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskSucceededEventDetails's
	// String and GoString methods.
	Output *string `locationName:"output" type:"string" sensitive:"true"`

	// Contains details about the output of an execution history event.
	OutputDetails *HistoryEventExecutionDataDetails `locationName:"outputDetails" type:"structure"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the successful completion of a task state.

func (TaskSucceededEventDetails) GoString

func (s TaskSucceededEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSucceededEventDetails) SetOutput

SetOutput sets the Output field's value.

func (*TaskSucceededEventDetails) SetOutputDetails

SetOutputDetails sets the OutputDetails field's value.

func (*TaskSucceededEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskSucceededEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskSucceededEventDetails) String

func (s TaskSucceededEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskTimedOut

type TaskTimedOut struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*TaskTimedOut) Code

func (s *TaskTimedOut) Code() string

Code returns the exception type name.

func (*TaskTimedOut) Error

func (s *TaskTimedOut) Error() string

func (TaskTimedOut) GoString

func (s TaskTimedOut) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskTimedOut) Message

func (s *TaskTimedOut) Message() string

Message returns the exception's message.

func (*TaskTimedOut) OrigErr

func (s *TaskTimedOut) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TaskTimedOut) RequestID

func (s *TaskTimedOut) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TaskTimedOut) StatusCode

func (s *TaskTimedOut) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TaskTimedOut) String

func (s TaskTimedOut) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskTimedOutEventDetails

type TaskTimedOutEventDetails struct {

	// A more detailed explanation of the cause of the failure.
	//
	// Cause is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskTimedOutEventDetails's
	// String and GoString methods.
	Cause *string `locationName:"cause" type:"string" sensitive:"true"`

	// The error code of the failure.
	//
	// Error is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TaskTimedOutEventDetails's
	// String and GoString methods.
	Error *string `locationName:"error" type:"string" sensitive:"true"`

	// The action of the resource called by a task state.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" min:"1" type:"string" required:"true"`

	// The service name of the resource in a task state.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a resource timeout that occurred during an execution.

func (TaskTimedOutEventDetails) GoString

func (s TaskTimedOutEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskTimedOutEventDetails) SetCause

SetCause sets the Cause field's value.

func (*TaskTimedOutEventDetails) SetError

SetError sets the Error field's value.

func (*TaskTimedOutEventDetails) SetResource

SetResource sets the Resource field's value.

func (*TaskTimedOutEventDetails) SetResourceType

SetResourceType sets the ResourceType field's value.

func (TaskTimedOutEventDetails) String

func (s TaskTimedOutEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTags

type TooManyTags struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	ResourceName *string `locationName:"resourceName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You've exceeded the number of tags allowed for a resource. See the Limits Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) in the Step Functions Developer Guide.

func (*TooManyTags) Code

func (s *TooManyTags) Code() string

Code returns the exception type name.

func (*TooManyTags) Error

func (s *TooManyTags) Error() string

func (TooManyTags) GoString

func (s TooManyTags) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTags) Message

func (s *TooManyTags) Message() string

Message returns the exception's message.

func (*TooManyTags) OrigErr

func (s *TooManyTags) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTags) RequestID

func (s *TooManyTags) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTags) StatusCode

func (s *TooManyTags) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTags) String

func (s TooManyTags) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TracingConfiguration

type TracingConfiguration struct {

	// When set to true, X-Ray tracing is enabled.
	Enabled *bool `locationName:"enabled" type:"boolean"`
	// contains filtered or unexported fields
}

Selects whether or not the state machine's X-Ray tracing is enabled. Default is false

func (TracingConfiguration) GoString

func (s TracingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TracingConfiguration) SetEnabled

SetEnabled sets the Enabled field's value.

func (TracingConfiguration) String

func (s TracingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The list of tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMapRunInput added in v1.42.9

type UpdateMapRunInput struct {

	// The Amazon Resource Name (ARN) of a Map Run.
	//
	// MapRunArn is a required field
	MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"`

	// The maximum number of child workflow executions that can be specified to
	// run in parallel for the Map Run at the same time.
	MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer"`

	// The maximum number of failed items before the Map Run fails.
	ToleratedFailureCount *int64 `locationName:"toleratedFailureCount" type:"long"`

	// The maximum percentage of failed items before the Map Run fails.
	ToleratedFailurePercentage *float64 `locationName:"toleratedFailurePercentage" type:"float"`
	// contains filtered or unexported fields
}

func (UpdateMapRunInput) GoString added in v1.42.9

func (s UpdateMapRunInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMapRunInput) SetMapRunArn added in v1.42.9

func (s *UpdateMapRunInput) SetMapRunArn(v string) *UpdateMapRunInput

SetMapRunArn sets the MapRunArn field's value.

func (*UpdateMapRunInput) SetMaxConcurrency added in v1.42.9

func (s *UpdateMapRunInput) SetMaxConcurrency(v int64) *UpdateMapRunInput

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*UpdateMapRunInput) SetToleratedFailureCount added in v1.42.9

func (s *UpdateMapRunInput) SetToleratedFailureCount(v int64) *UpdateMapRunInput

SetToleratedFailureCount sets the ToleratedFailureCount field's value.

func (*UpdateMapRunInput) SetToleratedFailurePercentage added in v1.42.9

func (s *UpdateMapRunInput) SetToleratedFailurePercentage(v float64) *UpdateMapRunInput

SetToleratedFailurePercentage sets the ToleratedFailurePercentage field's value.

func (UpdateMapRunInput) String added in v1.42.9

func (s UpdateMapRunInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMapRunInput) Validate added in v1.42.9

func (s *UpdateMapRunInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMapRunOutput added in v1.42.9

type UpdateMapRunOutput struct {
	// contains filtered or unexported fields
}

func (UpdateMapRunOutput) GoString added in v1.42.9

func (s UpdateMapRunOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateMapRunOutput) String added in v1.42.9

func (s UpdateMapRunOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStateMachineAliasInput added in v1.42.9

type UpdateStateMachineAliasInput struct {

	// A description of the state machine alias.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateStateMachineAliasInput's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The routing configuration of the state machine alias.
	//
	// An array of RoutingConfig objects that specifies up to two state machine
	// versions that the alias starts executions for.
	RoutingConfiguration []*RoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the state machine alias.
	//
	// StateMachineAliasArn is a required field
	StateMachineAliasArn *string `locationName:"stateMachineAliasArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStateMachineAliasInput) GoString added in v1.42.9

func (s UpdateStateMachineAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineAliasInput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*UpdateStateMachineAliasInput) SetRoutingConfiguration added in v1.42.9

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*UpdateStateMachineAliasInput) SetStateMachineAliasArn added in v1.42.9

func (s *UpdateStateMachineAliasInput) SetStateMachineAliasArn(v string) *UpdateStateMachineAliasInput

SetStateMachineAliasArn sets the StateMachineAliasArn field's value.

func (UpdateStateMachineAliasInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineAliasInput) Validate added in v1.42.9

func (s *UpdateStateMachineAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStateMachineAliasOutput added in v1.42.9

type UpdateStateMachineAliasOutput struct {

	// The date and time the state machine alias was updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStateMachineAliasOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineAliasOutput) SetUpdateDate added in v1.42.9

SetUpdateDate sets the UpdateDate field's value.

func (UpdateStateMachineAliasOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStateMachineInput

type UpdateStateMachineInput struct {

	// The Amazon States Language definition of the state machine. See Amazon States
	// Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).
	//
	// Definition is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateStateMachineInput's
	// String and GoString methods.
	Definition *string `locationName:"definition" min:"1" type:"string" sensitive:"true"`

	// Use the LoggingConfiguration data type to set CloudWatch Logs options.
	LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"`

	// Specifies whether the state machine version is published. The default is
	// false. To publish a version after updating the state machine, set publish
	// to true.
	Publish *bool `locationName:"publish" type:"boolean"`

	// The Amazon Resource Name (ARN) of the IAM role of the state machine.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the state machine.
	//
	// StateMachineArn is a required field
	StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"`

	// Selects whether X-Ray tracing is enabled.
	TracingConfiguration *TracingConfiguration `locationName:"tracingConfiguration" type:"structure"`

	// An optional description of the state machine version to publish.
	//
	// You can only specify the versionDescription parameter if you've set publish
	// to true.
	//
	// VersionDescription is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateStateMachineInput's
	// String and GoString methods.
	VersionDescription *string `locationName:"versionDescription" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateStateMachineInput) GoString

func (s UpdateStateMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineInput) SetDefinition

SetDefinition sets the Definition field's value.

func (*UpdateStateMachineInput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*UpdateStateMachineInput) SetPublish added in v1.42.9

SetPublish sets the Publish field's value.

func (*UpdateStateMachineInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*UpdateStateMachineInput) SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

func (*UpdateStateMachineInput) SetTracingConfiguration

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*UpdateStateMachineInput) SetVersionDescription added in v1.42.9

func (s *UpdateStateMachineInput) SetVersionDescription(v string) *UpdateStateMachineInput

SetVersionDescription sets the VersionDescription field's value.

func (UpdateStateMachineInput) String

func (s UpdateStateMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineInput) Validate

func (s *UpdateStateMachineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStateMachineOutput

type UpdateStateMachineOutput struct {

	// The revision identifier for the updated state machine.
	RevisionId *string `locationName:"revisionId" type:"string"`

	// The Amazon Resource Name (ARN) of the published state machine version.
	//
	// If the publish parameter isn't set to true, this field returns null.
	StateMachineVersionArn *string `locationName:"stateMachineVersionArn" min:"1" type:"string"`

	// The date and time the state machine was updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStateMachineOutput) GoString

func (s UpdateStateMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStateMachineOutput) SetRevisionId added in v1.42.9

SetRevisionId sets the RevisionId field's value.

func (*UpdateStateMachineOutput) SetStateMachineVersionArn added in v1.42.9

func (s *UpdateStateMachineOutput) SetStateMachineVersionArn(v string) *UpdateStateMachineOutput

SetStateMachineVersionArn sets the StateMachineVersionArn field's value.

func (*UpdateStateMachineOutput) SetUpdateDate

SetUpdateDate sets the UpdateDate field's value.

func (UpdateStateMachineOutput) String

func (s UpdateStateMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.42.9

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The input does not satisfy the constraints specified by an Amazon Web Services
	// service.
	Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input does not satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Code added in v1.42.9

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.42.9

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.42.9

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.42.9

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.42.9

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.42.9

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.42.9

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.42.9

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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