Documentation ¶
Overview ¶
Package sfn provides the client and types for making API requests to AWS Step Functions.
AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide (http://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 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
- type ActivityFailedEventDetails
- type ActivityListItem
- type ActivityScheduleFailedEventDetails
- type ActivityScheduledEventDetails
- type ActivityStartedEventDetails
- type ActivitySucceededEventDetails
- type ActivityTimedOutEventDetails
- type CreateActivityInput
- type CreateActivityOutput
- type CreateActivityRequest
- type CreateStateMachineInput
- type CreateStateMachineOutput
- type CreateStateMachineRequest
- type DeleteActivityInput
- type DeleteActivityOutput
- type DeleteActivityRequest
- type DeleteStateMachineInput
- type DeleteStateMachineOutput
- type DeleteStateMachineRequest
- type DescribeActivityInput
- type DescribeActivityOutput
- type DescribeActivityRequest
- type DescribeExecutionInput
- type DescribeExecutionOutput
- type DescribeExecutionRequest
- type DescribeStateMachineForExecutionInput
- type DescribeStateMachineForExecutionOutput
- type DescribeStateMachineForExecutionRequest
- type DescribeStateMachineInput
- type DescribeStateMachineOutput
- type DescribeStateMachineRequest
- type ExecutionAbortedEventDetails
- type ExecutionFailedEventDetails
- type ExecutionListItem
- type ExecutionStartedEventDetails
- type ExecutionStatus
- type ExecutionSucceededEventDetails
- type ExecutionTimedOutEventDetails
- type GetActivityTaskInput
- type GetActivityTaskOutput
- type GetActivityTaskRequest
- type GetExecutionHistoryInput
- type GetExecutionHistoryOutput
- type GetExecutionHistoryPager
- type GetExecutionHistoryRequest
- type HistoryEvent
- type HistoryEventType
- type LambdaFunctionFailedEventDetails
- type LambdaFunctionScheduleFailedEventDetails
- type LambdaFunctionScheduledEventDetails
- type LambdaFunctionStartFailedEventDetails
- type LambdaFunctionSucceededEventDetails
- type LambdaFunctionTimedOutEventDetails
- type ListActivitiesInput
- type ListActivitiesOutput
- type ListActivitiesPager
- type ListActivitiesRequest
- type ListExecutionsInput
- type ListExecutionsOutput
- type ListExecutionsPager
- type ListExecutionsRequest
- type ListStateMachinesInput
- type ListStateMachinesOutput
- type ListStateMachinesPager
- type ListStateMachinesRequest
- type SFN
- func (c *SFN) CreateActivityRequest(input *CreateActivityInput) CreateActivityRequest
- func (c *SFN) CreateStateMachineRequest(input *CreateStateMachineInput) CreateStateMachineRequest
- func (c *SFN) DeleteActivityRequest(input *DeleteActivityInput) DeleteActivityRequest
- func (c *SFN) DeleteStateMachineRequest(input *DeleteStateMachineInput) DeleteStateMachineRequest
- func (c *SFN) DescribeActivityRequest(input *DescribeActivityInput) DescribeActivityRequest
- func (c *SFN) DescribeExecutionRequest(input *DescribeExecutionInput) DescribeExecutionRequest
- func (c *SFN) DescribeStateMachineForExecutionRequest(input *DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest
- func (c *SFN) DescribeStateMachineRequest(input *DescribeStateMachineInput) DescribeStateMachineRequest
- func (c *SFN) GetActivityTaskRequest(input *GetActivityTaskInput) GetActivityTaskRequest
- func (c *SFN) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) GetExecutionHistoryRequest
- func (c *SFN) ListActivitiesRequest(input *ListActivitiesInput) ListActivitiesRequest
- func (c *SFN) ListExecutionsRequest(input *ListExecutionsInput) ListExecutionsRequest
- func (c *SFN) ListStateMachinesRequest(input *ListStateMachinesInput) ListStateMachinesRequest
- func (c *SFN) SendTaskFailureRequest(input *SendTaskFailureInput) SendTaskFailureRequest
- func (c *SFN) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) SendTaskHeartbeatRequest
- func (c *SFN) SendTaskSuccessRequest(input *SendTaskSuccessInput) SendTaskSuccessRequest
- func (c *SFN) StartExecutionRequest(input *StartExecutionInput) StartExecutionRequest
- func (c *SFN) StopExecutionRequest(input *StopExecutionInput) StopExecutionRequest
- func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) UpdateStateMachineRequest
- type SendTaskFailureInput
- type SendTaskFailureOutput
- type SendTaskFailureRequest
- type SendTaskHeartbeatInput
- type SendTaskHeartbeatOutput
- type SendTaskHeartbeatRequest
- type SendTaskSuccessInput
- type SendTaskSuccessOutput
- type SendTaskSuccessRequest
- type StartExecutionInput
- type StartExecutionOutput
- type StartExecutionRequest
- type StateEnteredEventDetails
- type StateExitedEventDetails
- type StateMachineListItem
- type StateMachineStatus
- type StopExecutionInput
- type StopExecutionOutput
- type StopExecutionRequest
- type UpdateStateMachineInput
- type UpdateStateMachineOutput
- type UpdateStateMachineRequest
Constants ¶
const ( // ErrCodeActivityDoesNotExist for service response error code // "ActivityDoesNotExist". // // The specified activity does not exist. ErrCodeActivityDoesNotExist = "ActivityDoesNotExist" // ErrCodeActivityLimitExceeded for service response error code // "ActivityLimitExceeded". // // The maximum number of activities has been reached. Existing activities must // be deleted before a new activity can be created. ErrCodeActivityLimitExceeded = "ActivityLimitExceeded" // ErrCodeActivityWorkerLimitExceeded for service response error code // "ActivityWorkerLimitExceeded". // // The maximum number of workers concurrently polling for activity tasks has // been reached. ErrCodeActivityWorkerLimitExceeded = "ActivityWorkerLimitExceeded" // ErrCodeExecutionAlreadyExists for service response error code // "ExecutionAlreadyExists". // // The execution has the same name as another execution (but a different input). // // Executions with the same name and input are considered idempotent. ErrCodeExecutionAlreadyExists = "ExecutionAlreadyExists" // ErrCodeExecutionDoesNotExist for service response error code // "ExecutionDoesNotExist". // // The specified execution does not exist. ErrCodeExecutionDoesNotExist = "ExecutionDoesNotExist" // ErrCodeExecutionLimitExceeded for service response error code // "ExecutionLimitExceeded". // // The maximum number of running executions has been reached. Running executions // must end or be stopped before a new execution can be started. ErrCodeExecutionLimitExceeded = "ExecutionLimitExceeded" // ErrCodeInvalidArn for service response error code // "InvalidArn". // // The provided Amazon Resource Name (ARN) is invalid. ErrCodeInvalidArn = "InvalidArn" // ErrCodeInvalidDefinition for service response error code // "InvalidDefinition". // // The provided Amazon States Language definition is invalid. ErrCodeInvalidDefinition = "InvalidDefinition" // ErrCodeInvalidExecutionInput for service response error code // "InvalidExecutionInput". // // The provided JSON input data is invalid. ErrCodeInvalidExecutionInput = "InvalidExecutionInput" // ErrCodeInvalidName for service response error code // "InvalidName". // // The provided name is invalid. ErrCodeInvalidName = "InvalidName" // ErrCodeInvalidOutput for service response error code // "InvalidOutput". // // The provided JSON output data is invalid. ErrCodeInvalidOutput = "InvalidOutput" // ErrCodeInvalidToken for service response error code // "InvalidToken". // // The provided token is invalid. ErrCodeInvalidToken = "InvalidToken" // ErrCodeMissingRequiredParameter for service response error code // "MissingRequiredParameter". // // Request is missing a required parameter. This error occurs if both definition // and roleArn are not specified. ErrCodeMissingRequiredParameter = "MissingRequiredParameter" // ErrCodeStateMachineAlreadyExists for service response error code // "StateMachineAlreadyExists". // // A state machine with the same name but a different definition or role ARN // already exists. ErrCodeStateMachineAlreadyExists = "StateMachineAlreadyExists" // ErrCodeStateMachineDeleting for service response error code // "StateMachineDeleting". // // The specified state machine is being deleted. ErrCodeStateMachineDeleting = "StateMachineDeleting" // ErrCodeStateMachineDoesNotExist for service response error code // "StateMachineDoesNotExist". // // The specified state machine does not exist. ErrCodeStateMachineDoesNotExist = "StateMachineDoesNotExist" // ErrCodeStateMachineLimitExceeded for service response error code // "StateMachineLimitExceeded". // // The maximum number of state machines has been reached. Existing state machines // must be deleted before a new state machine can be created. ErrCodeStateMachineLimitExceeded = "StateMachineLimitExceeded" // ErrCodeTaskDoesNotExist for service response error code // "TaskDoesNotExist". ErrCodeTaskDoesNotExist = "TaskDoesNotExist" // ErrCodeTaskTimedOut for service response error code // "TaskTimedOut". ErrCodeTaskTimedOut = "TaskTimedOut" )
const ( ServiceName = "states" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivityFailedEventDetails ¶
type ActivityFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity which failed during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityFailedEventDetails
func (ActivityFailedEventDetails) GoString ¶
func (s ActivityFailedEventDetails) GoString() string
GoString returns the string representation
func (ActivityFailedEventDetails) String ¶
func (s ActivityFailedEventDetails) String() string
String returns the string representation
type ActivityListItem ¶
type ActivityListItem struct { // The Amazon Resource Name (ARN) that identifies the activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The name of the activity. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about an activity. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityListItem
func (ActivityListItem) GoString ¶
func (s ActivityListItem) GoString() string
GoString returns the string representation
func (ActivityListItem) String ¶
func (s ActivityListItem) String() string
String returns the string representation
type ActivityScheduleFailedEventDetails ¶
type ActivityScheduleFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity schedule failure which occurred during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduleFailedEventDetails
func (ActivityScheduleFailedEventDetails) GoString ¶
func (s ActivityScheduleFailedEventDetails) GoString() string
GoString returns the string representation
func (ActivityScheduleFailedEventDetails) String ¶
func (s ActivityScheduleFailedEventDetails) String() string
String returns the string representation
type ActivityScheduledEventDetails ¶
type ActivityScheduledEventDetails struct { // The maximum allowed duration between two heartbeats for the activity task. HeartbeatInSeconds *int64 `locationName:"heartbeatInSeconds" type:"long"` // The JSON data input to the activity task. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the scheduled activity. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The maximum allowed duration of the activity task. TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` // contains filtered or unexported fields }
Contains details about an activity scheduled during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduledEventDetails
func (ActivityScheduledEventDetails) GoString ¶
func (s ActivityScheduledEventDetails) GoString() string
GoString returns the string representation
func (ActivityScheduledEventDetails) String ¶
func (s ActivityScheduledEventDetails) String() string
String returns the string representation
type ActivityStartedEventDetails ¶
type ActivityStartedEventDetails struct { // The name of the worker that the task is assigned to. These names are provided // by the workers when calling GetActivityTask. WorkerName *string `locationName:"workerName" type:"string"` // contains filtered or unexported fields }
Contains details about the start of an activity during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityStartedEventDetails
func (ActivityStartedEventDetails) GoString ¶
func (s ActivityStartedEventDetails) GoString() string
GoString returns the string representation
func (ActivityStartedEventDetails) String ¶
func (s ActivityStartedEventDetails) String() string
String returns the string representation
type ActivitySucceededEventDetails ¶
type ActivitySucceededEventDetails struct { // The JSON data output by the activity task. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about an activity which successfully terminated during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivitySucceededEventDetails
func (ActivitySucceededEventDetails) GoString ¶
func (s ActivitySucceededEventDetails) GoString() string
GoString returns the string representation
func (ActivitySucceededEventDetails) String ¶
func (s ActivitySucceededEventDetails) String() string
String returns the string representation
type ActivityTimedOutEventDetails ¶
type ActivityTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an activity timeout which occurred during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityTimedOutEventDetails
func (ActivityTimedOutEventDetails) GoString ¶
func (s ActivityTimedOutEventDetails) GoString() string
GoString returns the string representation
func (ActivityTimedOutEventDetails) String ¶
func (s ActivityTimedOutEventDetails) String() string
String returns the string representation
type CreateActivityInput ¶
type CreateActivityInput struct { // The name of the activity to create. This name must be unique for your AWS // account and region for 90 days. For more information, see Limits Related // to State Machine Executions (http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) // in the AWS Step Functions Developer Guide. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityInput
func (CreateActivityInput) GoString ¶
func (s CreateActivityInput) GoString() string
GoString returns the string representation
func (CreateActivityInput) String ¶
func (s CreateActivityInput) String() string
String returns the string representation
func (*CreateActivityInput) Validate ¶
func (s *CreateActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateActivityOutput ¶
type CreateActivityOutput struct { // The Amazon Resource Name (ARN) that identifies the created activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityOutput
func (CreateActivityOutput) GoString ¶
func (s CreateActivityOutput) GoString() string
GoString returns the string representation
func (CreateActivityOutput) SDKResponseMetadata ¶
func (s CreateActivityOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateActivityOutput) String ¶
func (s CreateActivityOutput) String() string
String returns the string representation
type CreateActivityRequest ¶
type CreateActivityRequest struct { *aws.Request Input *CreateActivityInput Copy func(*CreateActivityInput) CreateActivityRequest }
CreateActivityRequest is a API request type for the CreateActivity API operation.
func (CreateActivityRequest) Send ¶
func (r CreateActivityRequest) Send() (*CreateActivityOutput, error)
Send marshals and sends the CreateActivity API request.
type CreateStateMachineInput ¶
type CreateStateMachineInput struct { // The Amazon States Language definition of the state machine. // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // The name of the state machine. This name must be unique for your AWS account // and region for 90 days. For more information, see Limits Related to State // Machine Executions (http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) // in the AWS Step Functions Developer Guide. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role to use for this state machine. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineInput
func (CreateStateMachineInput) GoString ¶
func (s CreateStateMachineInput) GoString() string
GoString returns the string representation
func (CreateStateMachineInput) String ¶
func (s CreateStateMachineInput) String() string
String returns the string representation
func (*CreateStateMachineInput) Validate ¶
func (s *CreateStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStateMachineOutput ¶
type CreateStateMachineOutput struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) that identifies the created state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineOutput
func (CreateStateMachineOutput) GoString ¶
func (s CreateStateMachineOutput) GoString() string
GoString returns the string representation
func (CreateStateMachineOutput) SDKResponseMetadata ¶
func (s CreateStateMachineOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateStateMachineOutput) String ¶
func (s CreateStateMachineOutput) String() string
String returns the string representation
type CreateStateMachineRequest ¶
type CreateStateMachineRequest struct { *aws.Request Input *CreateStateMachineInput Copy func(*CreateStateMachineInput) CreateStateMachineRequest }
CreateStateMachineRequest is a API request type for the CreateStateMachine API operation.
func (CreateStateMachineRequest) Send ¶
func (r CreateStateMachineRequest) Send() (*CreateStateMachineOutput, error)
Send marshals and sends the CreateStateMachine API request.
type DeleteActivityInput ¶
type DeleteActivityInput struct { // The Amazon Resource Name (ARN) of the activity to delete. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityInput
func (DeleteActivityInput) GoString ¶
func (s DeleteActivityInput) GoString() string
GoString returns the string representation
func (DeleteActivityInput) String ¶
func (s DeleteActivityInput) String() string
String returns the string representation
func (*DeleteActivityInput) Validate ¶
func (s *DeleteActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteActivityOutput ¶
type DeleteActivityOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityOutput
func (DeleteActivityOutput) GoString ¶
func (s DeleteActivityOutput) GoString() string
GoString returns the string representation
func (DeleteActivityOutput) SDKResponseMetadata ¶
func (s DeleteActivityOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteActivityOutput) String ¶
func (s DeleteActivityOutput) String() string
String returns the string representation
type DeleteActivityRequest ¶
type DeleteActivityRequest struct { *aws.Request Input *DeleteActivityInput Copy func(*DeleteActivityInput) DeleteActivityRequest }
DeleteActivityRequest is a API request type for the DeleteActivity API operation.
func (DeleteActivityRequest) Send ¶
func (r DeleteActivityRequest) Send() (*DeleteActivityOutput, error)
Send marshals and sends the DeleteActivity API request.
type DeleteStateMachineInput ¶
type DeleteStateMachineInput struct { // The Amazon Resource Name (ARN) of the state machine to delete. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineInput
func (DeleteStateMachineInput) GoString ¶
func (s DeleteStateMachineInput) GoString() string
GoString returns the string representation
func (DeleteStateMachineInput) String ¶
func (s DeleteStateMachineInput) String() string
String returns the string representation
func (*DeleteStateMachineInput) Validate ¶
func (s *DeleteStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStateMachineOutput ¶
type DeleteStateMachineOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineOutput
func (DeleteStateMachineOutput) GoString ¶
func (s DeleteStateMachineOutput) GoString() string
GoString returns the string representation
func (DeleteStateMachineOutput) SDKResponseMetadata ¶
func (s DeleteStateMachineOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteStateMachineOutput) String ¶
func (s DeleteStateMachineOutput) String() string
String returns the string representation
type DeleteStateMachineRequest ¶
type DeleteStateMachineRequest struct { *aws.Request Input *DeleteStateMachineInput Copy func(*DeleteStateMachineInput) DeleteStateMachineRequest }
DeleteStateMachineRequest is a API request type for the DeleteStateMachine API operation.
func (DeleteStateMachineRequest) Send ¶
func (r DeleteStateMachineRequest) Send() (*DeleteStateMachineOutput, error)
Send marshals and sends the DeleteStateMachine API request.
type DescribeActivityInput ¶
type DescribeActivityInput struct { // The Amazon Resource Name (ARN) of the activity to describe. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityInput
func (DescribeActivityInput) GoString ¶
func (s DescribeActivityInput) GoString() string
GoString returns the string representation
func (DescribeActivityInput) String ¶
func (s DescribeActivityInput) String() string
String returns the string representation
func (*DescribeActivityInput) Validate ¶
func (s *DescribeActivityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeActivityOutput ¶
type DescribeActivityOutput struct { // The Amazon Resource Name (ARN) that identifies the activity. // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // The date the activity is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The name of the activity. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityOutput
func (DescribeActivityOutput) GoString ¶
func (s DescribeActivityOutput) GoString() string
GoString returns the string representation
func (DescribeActivityOutput) SDKResponseMetadata ¶
func (s DescribeActivityOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeActivityOutput) String ¶
func (s DescribeActivityOutput) String() string
String returns the string representation
type DescribeActivityRequest ¶
type DescribeActivityRequest struct { *aws.Request Input *DescribeActivityInput Copy func(*DescribeActivityInput) DescribeActivityRequest }
DescribeActivityRequest is a API request type for the DescribeActivity API operation.
func (DescribeActivityRequest) Send ¶
func (r DescribeActivityRequest) Send() (*DescribeActivityOutput, error)
Send marshals and sends the DescribeActivity API request.
type DescribeExecutionInput ¶
type DescribeExecutionInput struct { // The Amazon Resource Name (ARN) of the execution to describe. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionInput
func (DescribeExecutionInput) GoString ¶
func (s DescribeExecutionInput) GoString() string
GoString returns the string representation
func (DescribeExecutionInput) String ¶
func (s DescribeExecutionInput) String() string
String returns the string representation
func (*DescribeExecutionInput) Validate ¶
func (s *DescribeExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeExecutionOutput ¶
type DescribeExecutionOutput struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The string that contains the JSON input data of the execution. // // Input is a required field Input *string `locationName:"input" type:"string" required:"true"` // The name of the execution. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) Name *string `locationName:"name" min:"1" type:"string"` // The JSON output data of the execution. // // This field is set only if the execution succeeds. If the execution fails, // this field is null. Output *string `locationName:"output" type:"string"` // The date the execution is started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) of the executed stated machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the execution. // // Status is a required field Status ExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"` // If the execution has already ended, the date the execution stopped. StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionOutput
func (DescribeExecutionOutput) GoString ¶
func (s DescribeExecutionOutput) GoString() string
GoString returns the string representation
func (DescribeExecutionOutput) SDKResponseMetadata ¶
func (s DescribeExecutionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeExecutionOutput) String ¶
func (s DescribeExecutionOutput) String() string
String returns the string representation
type DescribeExecutionRequest ¶
type DescribeExecutionRequest struct { *aws.Request Input *DescribeExecutionInput Copy func(*DescribeExecutionInput) DescribeExecutionRequest }
DescribeExecutionRequest is a API request type for the DescribeExecution API operation.
func (DescribeExecutionRequest) Send ¶
func (r DescribeExecutionRequest) Send() (*DescribeExecutionOutput, error)
Send marshals and sends the DescribeExecution API request.
type DescribeStateMachineForExecutionInput ¶ added in v0.2.0
type DescribeStateMachineForExecutionInput struct { // The Amazon Resource Name (ARN) of the execution you want state machine information // for. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionInput
func (DescribeStateMachineForExecutionInput) GoString ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionInput) GoString() string
GoString returns the string representation
func (DescribeStateMachineForExecutionInput) String ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionInput) String() string
String returns the string representation
func (*DescribeStateMachineForExecutionInput) Validate ¶ added in v0.2.0
func (s *DescribeStateMachineForExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStateMachineForExecutionOutput ¶ added in v0.2.0
type DescribeStateMachineForExecutionOutput struct { // The Amazon States Language definition of the state machine. // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // The name of the state machine associated with the execution. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role of the State Machine for the // execution. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the state machine associated with the execution. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The date and time the state machine associated with an execution was updated. // For a newly created state machine, this is the creation date. // // UpdateDate is a required field UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionOutput
func (DescribeStateMachineForExecutionOutput) GoString ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionOutput) GoString() string
GoString returns the string representation
func (DescribeStateMachineForExecutionOutput) SDKResponseMetadata ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeStateMachineForExecutionOutput) String ¶ added in v0.2.0
func (s DescribeStateMachineForExecutionOutput) String() string
String returns the string representation
type DescribeStateMachineForExecutionRequest ¶ added in v0.2.0
type DescribeStateMachineForExecutionRequest struct { *aws.Request Input *DescribeStateMachineForExecutionInput Copy func(*DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest }
DescribeStateMachineForExecutionRequest is a API request type for the DescribeStateMachineForExecution API operation.
func (DescribeStateMachineForExecutionRequest) Send ¶ added in v0.2.0
func (r DescribeStateMachineForExecutionRequest) Send() (*DescribeStateMachineForExecutionOutput, error)
Send marshals and sends the DescribeStateMachineForExecution API request.
type DescribeStateMachineInput ¶
type DescribeStateMachineInput struct { // The Amazon Resource Name (ARN) of the state machine to describe. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineInput
func (DescribeStateMachineInput) GoString ¶
func (s DescribeStateMachineInput) GoString() string
GoString returns the string representation
func (DescribeStateMachineInput) String ¶
func (s DescribeStateMachineInput) String() string
String returns the string representation
func (*DescribeStateMachineInput) Validate ¶
func (s *DescribeStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStateMachineOutput ¶
type DescribeStateMachineOutput struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon States Language definition of the state machine. // // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true"` // The name of the state machine. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the IAM role used when creating this state // machine. (The IAM role maintains security by granting Step Functions access // to AWS resources.) // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) that identifies the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the state machine. Status StateMachineStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput
func (DescribeStateMachineOutput) GoString ¶
func (s DescribeStateMachineOutput) GoString() string
GoString returns the string representation
func (DescribeStateMachineOutput) SDKResponseMetadata ¶
func (s DescribeStateMachineOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeStateMachineOutput) String ¶
func (s DescribeStateMachineOutput) String() string
String returns the string representation
type DescribeStateMachineRequest ¶
type DescribeStateMachineRequest struct { *aws.Request Input *DescribeStateMachineInput Copy func(*DescribeStateMachineInput) DescribeStateMachineRequest }
DescribeStateMachineRequest is a API request type for the DescribeStateMachine API operation.
func (DescribeStateMachineRequest) Send ¶
func (r DescribeStateMachineRequest) Send() (*DescribeStateMachineOutput, error)
Send marshals and sends the DescribeStateMachine API request.
type ExecutionAbortedEventDetails ¶
type ExecutionAbortedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an abort of an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionAbortedEventDetails
func (ExecutionAbortedEventDetails) GoString ¶
func (s ExecutionAbortedEventDetails) GoString() string
GoString returns the string representation
func (ExecutionAbortedEventDetails) String ¶
func (s ExecutionAbortedEventDetails) String() string
String returns the string representation
type ExecutionFailedEventDetails ¶
type ExecutionFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about an execution failure event. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionFailedEventDetails
func (ExecutionFailedEventDetails) GoString ¶
func (s ExecutionFailedEventDetails) GoString() string
GoString returns the string representation
func (ExecutionFailedEventDetails) String ¶
func (s ExecutionFailedEventDetails) String() string
String returns the string representation
type ExecutionListItem ¶
type ExecutionListItem struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The name of the execution. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The date the execution started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) of the executed state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // The current status of the execution. // // Status is a required field Status ExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"` // If the execution already ended, the date the execution stopped. StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Contains details about an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionListItem
func (ExecutionListItem) GoString ¶
func (s ExecutionListItem) GoString() string
GoString returns the string representation
func (ExecutionListItem) String ¶
func (s ExecutionListItem) String() string
String returns the string representation
type ExecutionStartedEventDetails ¶
type ExecutionStartedEventDetails struct { // The JSON data input to the execution. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda // tasks. RoleArn *string `locationName:"roleArn" min:"1" type:"string"` // contains filtered or unexported fields }
Contains details about the start of the execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionStartedEventDetails
func (ExecutionStartedEventDetails) GoString ¶
func (s ExecutionStartedEventDetails) GoString() string
GoString returns the string representation
func (ExecutionStartedEventDetails) String ¶
func (s ExecutionStartedEventDetails) String() string
String returns the string representation
type ExecutionStatus ¶
type ExecutionStatus string
const ( ExecutionStatusRunning ExecutionStatus = "RUNNING" ExecutionStatusSucceeded ExecutionStatus = "SUCCEEDED" ExecutionStatusFailed ExecutionStatus = "FAILED" ExecutionStatusTimedOut ExecutionStatus = "TIMED_OUT" ExecutionStatusAborted ExecutionStatus = "ABORTED" )
Enum values for ExecutionStatus
func (ExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValue() (string, error)
func (ExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ExecutionSucceededEventDetails ¶
type ExecutionSucceededEventDetails struct { // The JSON data output by the execution. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about the successful termination of the execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionSucceededEventDetails
func (ExecutionSucceededEventDetails) GoString ¶
func (s ExecutionSucceededEventDetails) GoString() string
GoString returns the string representation
func (ExecutionSucceededEventDetails) String ¶
func (s ExecutionSucceededEventDetails) String() string
String returns the string representation
type ExecutionTimedOutEventDetails ¶
type ExecutionTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about the execution timeout which occurred during the execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionTimedOutEventDetails
func (ExecutionTimedOutEventDetails) GoString ¶
func (s ExecutionTimedOutEventDetails) GoString() string
GoString returns the string representation
func (ExecutionTimedOutEventDetails) String ¶
func (s ExecutionTimedOutEventDetails) String() string
String returns the string representation
type GetActivityTaskInput ¶
type GetActivityTaskInput struct { // The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned // when you create the task using CreateActivity.) // // ActivityArn is a required field ActivityArn *string `locationName:"activityArn" min:"1" type:"string" required:"true"` // You can provide an arbitrary name in order to identify the worker that the // task is assigned to. This name is used when it is logged in the execution // history. WorkerName *string `locationName:"workerName" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskInput
func (GetActivityTaskInput) GoString ¶
func (s GetActivityTaskInput) GoString() string
GoString returns the string representation
func (GetActivityTaskInput) String ¶
func (s GetActivityTaskInput) String() string
String returns the string representation
func (*GetActivityTaskInput) Validate ¶
func (s *GetActivityTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetActivityTaskOutput ¶
type GetActivityTaskOutput struct { // The string that contains the JSON input data for the task. Input *string `locationName:"input" type:"string"` // A token that identifies the scheduled task. This token must be copied and // included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure // in order to report the progress or completion of the task. TaskToken *string `locationName:"taskToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskOutput
func (GetActivityTaskOutput) GoString ¶
func (s GetActivityTaskOutput) GoString() string
GoString returns the string representation
func (GetActivityTaskOutput) SDKResponseMetadata ¶
func (s GetActivityTaskOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetActivityTaskOutput) String ¶
func (s GetActivityTaskOutput) String() string
String returns the string representation
type GetActivityTaskRequest ¶
type GetActivityTaskRequest struct { *aws.Request Input *GetActivityTaskInput Copy func(*GetActivityTaskInput) GetActivityTaskRequest }
GetActivityTaskRequest is a API request type for the GetActivityTask API operation.
func (GetActivityTaskRequest) Send ¶
func (r GetActivityTaskRequest) Send() (*GetActivityTaskOutput, error)
Send marshals and sends the GetActivityTask API request.
type GetExecutionHistoryInput ¶
type GetExecutionHistoryInput struct { // The Amazon Resource Name (ARN) of the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 100. 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 a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // Lists events in descending order of their timeStamp. ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryInput
func (GetExecutionHistoryInput) GoString ¶
func (s GetExecutionHistoryInput) GoString() string
GoString returns the string representation
func (GetExecutionHistoryInput) String ¶
func (s GetExecutionHistoryInput) String() string
String returns the string representation
func (*GetExecutionHistoryInput) Validate ¶
func (s *GetExecutionHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExecutionHistoryOutput ¶
type GetExecutionHistoryOutput struct { // The list of events that occurred in the execution. // // Events is a required field Events []HistoryEvent `locationName:"events" type:"list" required:"true"` // If a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryOutput
func (GetExecutionHistoryOutput) GoString ¶
func (s GetExecutionHistoryOutput) GoString() string
GoString returns the string representation
func (GetExecutionHistoryOutput) SDKResponseMetadata ¶
func (s GetExecutionHistoryOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetExecutionHistoryOutput) String ¶
func (s GetExecutionHistoryOutput) String() string
String returns the string representation
type GetExecutionHistoryPager ¶ added in v0.3.0
GetExecutionHistoryPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*GetExecutionHistoryPager) CurrentPage ¶ added in v0.3.0
func (p *GetExecutionHistoryPager) CurrentPage() *GetExecutionHistoryOutput
type GetExecutionHistoryRequest ¶
type GetExecutionHistoryRequest struct { *aws.Request Input *GetExecutionHistoryInput Copy func(*GetExecutionHistoryInput) GetExecutionHistoryRequest }
GetExecutionHistoryRequest is a API request type for the GetExecutionHistory API operation.
func (*GetExecutionHistoryRequest) Paginate ¶ added in v0.3.0
func (p *GetExecutionHistoryRequest) Paginate(opts ...aws.Option) GetExecutionHistoryPager
Paginate pages iterates over the pages of a GetExecutionHistoryRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a GetExecutionHistory operation. req := client.GetExecutionHistoryRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (GetExecutionHistoryRequest) Send ¶
func (r GetExecutionHistoryRequest) Send() (*GetExecutionHistoryOutput, error)
Send marshals and sends the GetExecutionHistory API request.
type HistoryEvent ¶
type HistoryEvent struct { // Contains details about an activity which failed during an execution. ActivityFailedEventDetails *ActivityFailedEventDetails `locationName:"activityFailedEventDetails" type:"structure"` // Contains details about an activity schedule event which 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 which successfully terminated during an // execution. ActivitySucceededEventDetails *ActivitySucceededEventDetails `locationName:"activitySucceededEventDetails" type:"structure"` // Contains details about an activity timeout which 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 which 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 which failed during an execution. LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails `locationName:"lambdaFunctionFailedEventDetails" type:"structure"` // Contains details about a failed lambda function schedule event which 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 which failed to start during an // execution. LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails `locationName:"lambdaFunctionStartFailedEventDetails" type:"structure"` // Contains details about a lambda function which terminated successfully during // an execution. LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails `locationName:"lambdaFunctionSucceededEventDetails" type:"structure"` // Contains details about a lambda function timeout which occurred during an // execution. LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails `locationName:"lambdaFunctionTimedOutEventDetails" 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"` // The date the event occurred. // // Timestamp is a required field Timestamp *time.Time `locationName:"timestamp" type:"timestamp" timestampFormat:"unix" required:"true"` // The type of the event. // // Type is a required field Type HistoryEventType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains details about the events of an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEvent
func (HistoryEvent) GoString ¶
func (s HistoryEvent) GoString() string
GoString returns the string representation
func (HistoryEvent) String ¶
func (s HistoryEvent) String() string
String returns the string representation
type HistoryEventType ¶
type HistoryEventType string
const ( HistoryEventTypeActivityFailed HistoryEventType = "ActivityFailed" HistoryEventTypeActivityScheduleFailed HistoryEventType = "ActivityScheduleFailed" HistoryEventTypeActivityScheduled HistoryEventType = "ActivityScheduled" HistoryEventTypeActivityStarted HistoryEventType = "ActivityStarted" HistoryEventTypeActivitySucceeded HistoryEventType = "ActivitySucceeded" HistoryEventTypeActivityTimedOut HistoryEventType = "ActivityTimedOut" HistoryEventTypeChoiceStateEntered HistoryEventType = "ChoiceStateEntered" HistoryEventTypeChoiceStateExited HistoryEventType = "ChoiceStateExited" HistoryEventTypeExecutionFailed HistoryEventType = "ExecutionFailed" HistoryEventTypeExecutionStarted HistoryEventType = "ExecutionStarted" HistoryEventTypeExecutionSucceeded HistoryEventType = "ExecutionSucceeded" HistoryEventTypeExecutionAborted HistoryEventType = "ExecutionAborted" HistoryEventTypeExecutionTimedOut HistoryEventType = "ExecutionTimedOut" HistoryEventTypeFailStateEntered HistoryEventType = "FailStateEntered" HistoryEventTypeLambdaFunctionFailed HistoryEventType = "LambdaFunctionFailed" HistoryEventTypeLambdaFunctionScheduleFailed HistoryEventType = "LambdaFunctionScheduleFailed" HistoryEventTypeLambdaFunctionScheduled HistoryEventType = "LambdaFunctionScheduled" HistoryEventTypeLambdaFunctionStartFailed HistoryEventType = "LambdaFunctionStartFailed" HistoryEventTypeLambdaFunctionStarted HistoryEventType = "LambdaFunctionStarted" HistoryEventTypeLambdaFunctionSucceeded HistoryEventType = "LambdaFunctionSucceeded" HistoryEventTypeLambdaFunctionTimedOut HistoryEventType = "LambdaFunctionTimedOut" HistoryEventTypeSucceedStateEntered HistoryEventType = "SucceedStateEntered" HistoryEventTypeSucceedStateExited HistoryEventType = "SucceedStateExited" HistoryEventTypeTaskStateAborted HistoryEventType = "TaskStateAborted" HistoryEventTypeTaskStateEntered HistoryEventType = "TaskStateEntered" HistoryEventTypeTaskStateExited HistoryEventType = "TaskStateExited" HistoryEventTypePassStateEntered HistoryEventType = "PassStateEntered" HistoryEventTypePassStateExited HistoryEventType = "PassStateExited" HistoryEventTypeParallelStateAborted HistoryEventType = "ParallelStateAborted" HistoryEventTypeParallelStateEntered HistoryEventType = "ParallelStateEntered" HistoryEventTypeParallelStateExited HistoryEventType = "ParallelStateExited" HistoryEventTypeParallelStateFailed HistoryEventType = "ParallelStateFailed" HistoryEventTypeParallelStateStarted HistoryEventType = "ParallelStateStarted" HistoryEventTypeParallelStateSucceeded HistoryEventType = "ParallelStateSucceeded" HistoryEventTypeWaitStateAborted HistoryEventType = "WaitStateAborted" HistoryEventTypeWaitStateEntered HistoryEventType = "WaitStateEntered" HistoryEventTypeWaitStateExited HistoryEventType = "WaitStateExited" )
Enum values for HistoryEventType
func (HistoryEventType) MarshalValue ¶ added in v0.3.0
func (enum HistoryEventType) MarshalValue() (string, error)
func (HistoryEventType) MarshalValueBuf ¶ added in v0.3.0
func (enum HistoryEventType) MarshalValueBuf(b []byte) ([]byte, error)
type LambdaFunctionFailedEventDetails ¶
type LambdaFunctionFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function which failed during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionFailedEventDetails
func (LambdaFunctionFailedEventDetails) GoString ¶
func (s LambdaFunctionFailedEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionFailedEventDetails) String ¶
func (s LambdaFunctionFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionScheduleFailedEventDetails ¶
type LambdaFunctionScheduleFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a failed lambda function schedule event which occurred during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduleFailedEventDetails
func (LambdaFunctionScheduleFailedEventDetails) GoString ¶
func (s LambdaFunctionScheduleFailedEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionScheduleFailedEventDetails) String ¶
func (s LambdaFunctionScheduleFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionScheduledEventDetails ¶
type LambdaFunctionScheduledEventDetails struct { // The JSON data input to the lambda function. Input *string `locationName:"input" type:"string"` // The Amazon Resource Name (ARN) of the scheduled lambda function. // // Resource is a required field Resource *string `locationName:"resource" min:"1" type:"string" required:"true"` // The maximum allowed duration of the lambda function. TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` // contains filtered or unexported fields }
Contains details about a lambda function scheduled during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduledEventDetails
func (LambdaFunctionScheduledEventDetails) GoString ¶
func (s LambdaFunctionScheduledEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionScheduledEventDetails) String ¶
func (s LambdaFunctionScheduledEventDetails) String() string
String returns the string representation
type LambdaFunctionStartFailedEventDetails ¶
type LambdaFunctionStartFailedEventDetails struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function which failed to start during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionStartFailedEventDetails
func (LambdaFunctionStartFailedEventDetails) GoString ¶
func (s LambdaFunctionStartFailedEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionStartFailedEventDetails) String ¶
func (s LambdaFunctionStartFailedEventDetails) String() string
String returns the string representation
type LambdaFunctionSucceededEventDetails ¶
type LambdaFunctionSucceededEventDetails struct { // The JSON data output by the lambda function. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function which successfully terminated during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionSucceededEventDetails
func (LambdaFunctionSucceededEventDetails) GoString ¶
func (s LambdaFunctionSucceededEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionSucceededEventDetails) String ¶
func (s LambdaFunctionSucceededEventDetails) String() string
String returns the string representation
type LambdaFunctionTimedOutEventDetails ¶
type LambdaFunctionTimedOutEventDetails struct { // A more detailed explanation of the cause of the timeout. Cause *string `locationName:"cause" type:"string"` // The error code of the failure. Error *string `locationName:"error" type:"string"` // contains filtered or unexported fields }
Contains details about a lambda function timeout which occurred during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionTimedOutEventDetails
func (LambdaFunctionTimedOutEventDetails) GoString ¶
func (s LambdaFunctionTimedOutEventDetails) GoString() string
GoString returns the string representation
func (LambdaFunctionTimedOutEventDetails) String ¶
func (s LambdaFunctionTimedOutEventDetails) String() string
String returns the string representation
type ListActivitiesInput ¶
type ListActivitiesInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 100. 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 a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesInput
func (ListActivitiesInput) GoString ¶
func (s ListActivitiesInput) GoString() string
GoString returns the string representation
func (ListActivitiesInput) String ¶
func (s ListActivitiesInput) String() string
String returns the string representation
func (*ListActivitiesInput) Validate ¶
func (s *ListActivitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListActivitiesOutput ¶
type ListActivitiesOutput struct { // The list of activities. // // Activities is a required field Activities []ActivityListItem `locationName:"activities" type:"list" required:"true"` // If a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesOutput
func (ListActivitiesOutput) GoString ¶
func (s ListActivitiesOutput) GoString() string
GoString returns the string representation
func (ListActivitiesOutput) SDKResponseMetadata ¶
func (s ListActivitiesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListActivitiesOutput) String ¶
func (s ListActivitiesOutput) String() string
String returns the string representation
type ListActivitiesPager ¶ added in v0.3.0
ListActivitiesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListActivitiesPager) CurrentPage ¶ added in v0.3.0
func (p *ListActivitiesPager) CurrentPage() *ListActivitiesOutput
type ListActivitiesRequest ¶
type ListActivitiesRequest struct { *aws.Request Input *ListActivitiesInput Copy func(*ListActivitiesInput) ListActivitiesRequest }
ListActivitiesRequest is a API request type for the ListActivities API operation.
func (*ListActivitiesRequest) Paginate ¶ added in v0.3.0
func (p *ListActivitiesRequest) Paginate(opts ...aws.Option) ListActivitiesPager
Paginate pages iterates over the pages of a ListActivitiesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListActivities operation. req := client.ListActivitiesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListActivitiesRequest) Send ¶
func (r ListActivitiesRequest) Send() (*ListActivitiesOutput, error)
Send marshals and sends the ListActivities API request.
type ListExecutionsInput ¶
type ListExecutionsInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 100. 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 a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine whose executions is listed. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // If specified, only list the executions whose current execution status matches // the given filter. StatusFilter ExecutionStatus `locationName:"statusFilter" type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsInput
func (ListExecutionsInput) GoString ¶
func (s ListExecutionsInput) GoString() string
GoString returns the string representation
func (ListExecutionsInput) String ¶
func (s ListExecutionsInput) String() string
String returns the string representation
func (*ListExecutionsInput) Validate ¶
func (s *ListExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListExecutionsOutput ¶
type ListExecutionsOutput struct { // The list of matching executions. // // Executions is a required field Executions []ExecutionListItem `locationName:"executions" type:"list" required:"true"` // If a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsOutput
func (ListExecutionsOutput) GoString ¶
func (s ListExecutionsOutput) GoString() string
GoString returns the string representation
func (ListExecutionsOutput) SDKResponseMetadata ¶
func (s ListExecutionsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListExecutionsOutput) String ¶
func (s ListExecutionsOutput) String() string
String returns the string representation
type ListExecutionsPager ¶ added in v0.3.0
ListExecutionsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListExecutionsPager) CurrentPage ¶ added in v0.3.0
func (p *ListExecutionsPager) CurrentPage() *ListExecutionsOutput
type ListExecutionsRequest ¶
type ListExecutionsRequest struct { *aws.Request Input *ListExecutionsInput Copy func(*ListExecutionsInput) ListExecutionsRequest }
ListExecutionsRequest is a API request type for the ListExecutions API operation.
func (*ListExecutionsRequest) Paginate ¶ added in v0.3.0
func (p *ListExecutionsRequest) Paginate(opts ...aws.Option) ListExecutionsPager
Paginate pages iterates over the pages of a ListExecutionsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListExecutions operation. req := client.ListExecutionsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListExecutionsRequest) Send ¶
func (r ListExecutionsRequest) Send() (*ListExecutionsOutput, error)
Send marshals and sends the ListExecutions API request.
type ListStateMachinesInput ¶
type ListStateMachinesInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 100. 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 a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesInput
func (ListStateMachinesInput) GoString ¶
func (s ListStateMachinesInput) GoString() string
GoString returns the string representation
func (ListStateMachinesInput) String ¶
func (s ListStateMachinesInput) String() string
String returns the string representation
func (*ListStateMachinesInput) Validate ¶
func (s *ListStateMachinesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStateMachinesOutput ¶
type ListStateMachinesOutput struct { // If a nextToken is returned by a previous call, there are more results available. // To retrieve the next page of results, make the call again using the returned // token in nextToken. Keep all other arguments unchanged. // // The configured maxResults determines how many results can be returned in // a single call. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // StateMachines is a required field StateMachines []StateMachineListItem `locationName:"stateMachines" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesOutput
func (ListStateMachinesOutput) GoString ¶
func (s ListStateMachinesOutput) GoString() string
GoString returns the string representation
func (ListStateMachinesOutput) SDKResponseMetadata ¶
func (s ListStateMachinesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListStateMachinesOutput) String ¶
func (s ListStateMachinesOutput) String() string
String returns the string representation
type ListStateMachinesPager ¶ added in v0.3.0
ListStateMachinesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListStateMachinesPager) CurrentPage ¶ added in v0.3.0
func (p *ListStateMachinesPager) CurrentPage() *ListStateMachinesOutput
type ListStateMachinesRequest ¶
type ListStateMachinesRequest struct { *aws.Request Input *ListStateMachinesInput Copy func(*ListStateMachinesInput) ListStateMachinesRequest }
ListStateMachinesRequest is a API request type for the ListStateMachines API operation.
func (*ListStateMachinesRequest) Paginate ¶ added in v0.3.0
func (p *ListStateMachinesRequest) Paginate(opts ...aws.Option) ListStateMachinesPager
Paginate pages iterates over the pages of a ListStateMachinesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListStateMachines operation. req := client.ListStateMachinesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListStateMachinesRequest) Send ¶
func (r ListStateMachinesRequest) Send() (*ListStateMachinesOutput, error)
Send marshals and sends the ListStateMachines API request.
type SFN ¶
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 ¶
New creates a new instance of the SFN client with a config.
Example:
// Create a SFN client from just a config. svc := sfn.New(myConfig)
func (*SFN) CreateActivityRequest ¶
func (c *SFN) CreateActivityRequest(input *CreateActivityInput) CreateActivityRequest
CreateActivityRequest returns a request value for making API operation for AWS Step Functions.
Creates an activity. An activity is a task which you write in any programming language and host on any machine which has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
// Example sending a request using the CreateActivityRequest method. req := client.CreateActivityRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivity
func (*SFN) CreateStateMachineRequest ¶
func (c *SFN) CreateStateMachineRequest(input *CreateStateMachineInput) CreateStateMachineRequest
CreateStateMachineRequest returns a request value for making API operation for AWS Step Functions.
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.
// Example sending a request using the CreateStateMachineRequest method. req := client.CreateStateMachineRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachine
func (*SFN) DeleteActivityRequest ¶
func (c *SFN) DeleteActivityRequest(input *DeleteActivityInput) DeleteActivityRequest
DeleteActivityRequest returns a request value for making API operation for AWS Step Functions.
Deletes an activity.
// Example sending a request using the DeleteActivityRequest method. req := client.DeleteActivityRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity
func (*SFN) DeleteStateMachineRequest ¶
func (c *SFN) DeleteStateMachineRequest(input *DeleteStateMachineInput) DeleteStateMachineRequest
DeleteStateMachineRequest returns a request value for making API operation for AWS Step Functions.
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.
The state machine itself is deleted after all executions are completed or deleted.
// Example sending a request using the DeleteStateMachineRequest method. req := client.DeleteStateMachineRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine
func (*SFN) DescribeActivityRequest ¶
func (c *SFN) DescribeActivityRequest(input *DescribeActivityInput) DescribeActivityRequest
DescribeActivityRequest returns a request value for making API operation for AWS Step Functions.
Describes an activity.
// Example sending a request using the DescribeActivityRequest method. req := client.DescribeActivityRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity
func (*SFN) DescribeExecutionRequest ¶
func (c *SFN) DescribeExecutionRequest(input *DescribeExecutionInput) DescribeExecutionRequest
DescribeExecutionRequest returns a request value for making API operation for AWS Step Functions.
Describes an execution.
// Example sending a request using the DescribeExecutionRequest method. req := client.DescribeExecutionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution
func (*SFN) DescribeStateMachineForExecutionRequest ¶ added in v0.2.0
func (c *SFN) DescribeStateMachineForExecutionRequest(input *DescribeStateMachineForExecutionInput) DescribeStateMachineForExecutionRequest
DescribeStateMachineForExecutionRequest returns a request value for making API operation for AWS Step Functions.
Describes the state machine associated with a specific execution.
// Example sending a request using the DescribeStateMachineForExecutionRequest method. req := client.DescribeStateMachineForExecutionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution
func (*SFN) DescribeStateMachineRequest ¶
func (c *SFN) DescribeStateMachineRequest(input *DescribeStateMachineInput) DescribeStateMachineRequest
DescribeStateMachineRequest returns a request value for making API operation for AWS Step Functions.
Describes a state machine.
// Example sending a request using the DescribeStateMachineRequest method. req := client.DescribeStateMachineRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine
func (*SFN) GetActivityTaskRequest ¶
func (c *SFN) GetActivityTaskRequest(input *GetActivityTaskInput) GetActivityTaskRequest
GetActivityTaskRequest returns a request value for making API operation for AWS Step Functions.
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
// Example sending a request using the GetActivityTaskRequest method. req := client.GetActivityTaskRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask
func (*SFN) GetExecutionHistoryRequest ¶
func (c *SFN) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) GetExecutionHistoryRequest
GetExecutionHistoryRequest returns a request value for making API operation for AWS Step Functions.
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
// Example sending a request using the GetExecutionHistoryRequest method. req := client.GetExecutionHistoryRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory
func (*SFN) ListActivitiesRequest ¶
func (c *SFN) ListActivitiesRequest(input *ListActivitiesInput) ListActivitiesRequest
ListActivitiesRequest returns a request value for making API operation for AWS Step Functions.
Lists the existing activities.
If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
// Example sending a request using the ListActivitiesRequest method. req := client.ListActivitiesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities
func (*SFN) ListExecutionsRequest ¶
func (c *SFN) ListExecutionsRequest(input *ListExecutionsInput) ListExecutionsRequest
ListExecutionsRequest returns a request value for making API operation for AWS Step Functions.
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
// Example sending a request using the ListExecutionsRequest method. req := client.ListExecutionsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions
func (*SFN) ListStateMachinesRequest ¶
func (c *SFN) ListStateMachinesRequest(input *ListStateMachinesInput) ListStateMachinesRequest
ListStateMachinesRequest returns a request value for making API operation for AWS Step Functions.
Lists the existing state machines.
If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
// Example sending a request using the ListStateMachinesRequest method. req := client.ListStateMachinesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines
func (*SFN) SendTaskFailureRequest ¶
func (c *SFN) SendTaskFailureRequest(input *SendTaskFailureInput) SendTaskFailureRequest
SendTaskFailureRequest returns a request value for making API operation for AWS Step Functions.
Used by workers to report that the task identified by the taskToken failed.
// Example sending a request using the SendTaskFailureRequest method. req := client.SendTaskFailureRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailure
func (*SFN) SendTaskHeartbeatRequest ¶
func (c *SFN) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) SendTaskHeartbeatRequest
SendTaskHeartbeatRequest returns a request value for making API operation for AWS Step Functions.
Used by workers to report to the service 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. 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 event.
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.
This operation is only useful for long-lived tasks to report the liveliness of the task.
// Example sending a request using the SendTaskHeartbeatRequest method. req := client.SendTaskHeartbeatRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeat
func (*SFN) SendTaskSuccessRequest ¶
func (c *SFN) SendTaskSuccessRequest(input *SendTaskSuccessInput) SendTaskSuccessRequest
SendTaskSuccessRequest returns a request value for making API operation for AWS Step Functions.
Used by workers to report that the task identified by the taskToken completed successfully.
// Example sending a request using the SendTaskSuccessRequest method. req := client.SendTaskSuccessRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccess
func (*SFN) StartExecutionRequest ¶
func (c *SFN) StartExecutionRequest(input *StartExecutionInput) StartExecutionRequest
StartExecutionRequest returns a request value for making API operation for AWS Step Functions.
Starts a state machine execution.
// Example sending a request using the StartExecutionRequest method. req := client.StartExecutionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution
func (*SFN) StopExecutionRequest ¶
func (c *SFN) StopExecutionRequest(input *StopExecutionInput) StopExecutionRequest
StopExecutionRequest returns a request value for making API operation for AWS Step Functions.
Stops an execution.
// Example sending a request using the StopExecutionRequest method. req := client.StopExecutionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution
func (*SFN) UpdateStateMachineRequest ¶ added in v0.2.0
func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) UpdateStateMachineRequest
UpdateStateMachineRequest returns a request value for making API operation for AWS Step Functions.
Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
// Example sending a request using the UpdateStateMachineRequest method. req := client.UpdateStateMachineRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachine
type SendTaskFailureInput ¶
type SendTaskFailureInput struct { // A more detailed explanation of the cause of the failure. Cause *string `locationName:"cause" type:"string"` // An arbitrary error code that identifies the cause of the failure. Error *string `locationName:"error" type:"string"` // The token that represents this task. Task tokens are generated by the service // when the tasks are assigned to a worker (see GetActivityTask::taskToken). // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureInput
func (SendTaskFailureInput) GoString ¶
func (s SendTaskFailureInput) GoString() string
GoString returns the string representation
func (SendTaskFailureInput) String ¶
func (s SendTaskFailureInput) String() string
String returns the string representation
func (*SendTaskFailureInput) Validate ¶
func (s *SendTaskFailureInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskFailureOutput ¶
type SendTaskFailureOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureOutput
func (SendTaskFailureOutput) GoString ¶
func (s SendTaskFailureOutput) GoString() string
GoString returns the string representation
func (SendTaskFailureOutput) SDKResponseMetadata ¶
func (s SendTaskFailureOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SendTaskFailureOutput) String ¶
func (s SendTaskFailureOutput) String() string
String returns the string representation
type SendTaskFailureRequest ¶
type SendTaskFailureRequest struct { *aws.Request Input *SendTaskFailureInput Copy func(*SendTaskFailureInput) SendTaskFailureRequest }
SendTaskFailureRequest is a API request type for the SendTaskFailure API operation.
func (SendTaskFailureRequest) Send ¶
func (r SendTaskFailureRequest) Send() (*SendTaskFailureOutput, error)
Send marshals and sends the SendTaskFailure API request.
type SendTaskHeartbeatInput ¶
type SendTaskHeartbeatInput struct { // The token that represents this task. Task tokens are generated by the service // when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken). // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatInput
func (SendTaskHeartbeatInput) GoString ¶
func (s SendTaskHeartbeatInput) GoString() string
GoString returns the string representation
func (SendTaskHeartbeatInput) String ¶
func (s SendTaskHeartbeatInput) String() string
String returns the string representation
func (*SendTaskHeartbeatInput) Validate ¶
func (s *SendTaskHeartbeatInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskHeartbeatOutput ¶
type SendTaskHeartbeatOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatOutput
func (SendTaskHeartbeatOutput) GoString ¶
func (s SendTaskHeartbeatOutput) GoString() string
GoString returns the string representation
func (SendTaskHeartbeatOutput) SDKResponseMetadata ¶
func (s SendTaskHeartbeatOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SendTaskHeartbeatOutput) String ¶
func (s SendTaskHeartbeatOutput) String() string
String returns the string representation
type SendTaskHeartbeatRequest ¶
type SendTaskHeartbeatRequest struct { *aws.Request Input *SendTaskHeartbeatInput Copy func(*SendTaskHeartbeatInput) SendTaskHeartbeatRequest }
SendTaskHeartbeatRequest is a API request type for the SendTaskHeartbeat API operation.
func (SendTaskHeartbeatRequest) Send ¶
func (r SendTaskHeartbeatRequest) Send() (*SendTaskHeartbeatOutput, error)
Send marshals and sends the SendTaskHeartbeat API request.
type SendTaskSuccessInput ¶
type SendTaskSuccessInput struct { // The JSON output of the task. // // Output is a required field Output *string `locationName:"output" type:"string" required:"true"` // The token that represents this task. Task tokens are generated by the service // when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken). // // TaskToken is a required field TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessInput
func (SendTaskSuccessInput) GoString ¶
func (s SendTaskSuccessInput) GoString() string
GoString returns the string representation
func (SendTaskSuccessInput) String ¶
func (s SendTaskSuccessInput) String() string
String returns the string representation
func (*SendTaskSuccessInput) Validate ¶
func (s *SendTaskSuccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendTaskSuccessOutput ¶
type SendTaskSuccessOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessOutput
func (SendTaskSuccessOutput) GoString ¶
func (s SendTaskSuccessOutput) GoString() string
GoString returns the string representation
func (SendTaskSuccessOutput) SDKResponseMetadata ¶
func (s SendTaskSuccessOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SendTaskSuccessOutput) String ¶
func (s SendTaskSuccessOutput) String() string
String returns the string representation
type SendTaskSuccessRequest ¶
type SendTaskSuccessRequest struct { *aws.Request Input *SendTaskSuccessInput Copy func(*SendTaskSuccessInput) SendTaskSuccessRequest }
SendTaskSuccessRequest is a API request type for the SendTaskSuccess API operation.
func (SendTaskSuccessRequest) Send ¶
func (r SendTaskSuccessRequest) Send() (*SendTaskSuccessOutput, error)
Send marshals and sends the SendTaskSuccess API request.
type StartExecutionInput ¶
type StartExecutionInput struct { // The string that contains the JSON input data for the execution, for example: // // "input": "{\"first_name\" : \"test\"}" // // If you don't include any JSON input data, you still must include the two // braces, for example: "input": "{}" Input *string `locationName:"input" type:"string"` // The name of the execution. This name must be unique for your AWS account // and region for 90 days. For more information, see Limits Related to State // Machine Executions (http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) // in the AWS Step Functions Developer Guide. // // An execution can't use the name of another execution for 90 days. // // When you make multiple StartExecution calls with the same name, the new execution // doesn't run and the following rules apply: // // When the original execution is open and the execution input from the new // call is different, the ExecutionAlreadyExists message is returned. // // When the original execution is open and the execution input from the new // call is identical, the Success message is returned. // // When the original execution is closed, the ExecutionAlreadyExists message // is returned regardless of input. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) Name *string `locationName:"name" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine to execute. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput
func (StartExecutionInput) GoString ¶
func (s StartExecutionInput) GoString() string
GoString returns the string representation
func (StartExecutionInput) String ¶
func (s StartExecutionInput) String() string
String returns the string representation
func (*StartExecutionInput) Validate ¶
func (s *StartExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartExecutionOutput ¶
type StartExecutionOutput struct { // The Amazon Resource Name (ARN) that identifies the execution. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // The date the execution is started. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionOutput
func (StartExecutionOutput) GoString ¶
func (s StartExecutionOutput) GoString() string
GoString returns the string representation
func (StartExecutionOutput) SDKResponseMetadata ¶
func (s StartExecutionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StartExecutionOutput) String ¶
func (s StartExecutionOutput) String() string
String returns the string representation
type StartExecutionRequest ¶
type StartExecutionRequest struct { *aws.Request Input *StartExecutionInput Copy func(*StartExecutionInput) StartExecutionRequest }
StartExecutionRequest is a API request type for the StartExecution API operation.
func (StartExecutionRequest) Send ¶
func (r StartExecutionRequest) Send() (*StartExecutionOutput, error)
Send marshals and sends the StartExecution API request.
type StateEnteredEventDetails ¶
type StateEnteredEventDetails struct { // The string that contains the JSON input data for the state. Input *string `locationName:"input" type:"string"` // The name of the state. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about a state entered during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateEnteredEventDetails
func (StateEnteredEventDetails) GoString ¶
func (s StateEnteredEventDetails) GoString() string
GoString returns the string representation
func (StateEnteredEventDetails) String ¶
func (s StateEnteredEventDetails) String() string
String returns the string representation
type StateExitedEventDetails ¶
type StateExitedEventDetails struct { // The name of the state. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The JSON output data of the state. Output *string `locationName:"output" type:"string"` // contains filtered or unexported fields }
Contains details about an exit from a state during an execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateExitedEventDetails
func (StateExitedEventDetails) GoString ¶
func (s StateExitedEventDetails) GoString() string
GoString returns the string representation
func (StateExitedEventDetails) String ¶
func (s StateExitedEventDetails) String() string
String returns the string representation
type StateMachineListItem ¶
type StateMachineListItem struct { // The date the state machine is created. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The name of the state machine. // // A name must not contain: // // * whitespace // // * brackets < > { } [ ] // // * wildcard characters ? * // // * special characters " # % \ ^ | ~ ` $ & , ; : / // // * control characters (U+0000-001F, U+007F-009F) // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) that identifies the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains details about the state machine. Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateMachineListItem
func (StateMachineListItem) GoString ¶
func (s StateMachineListItem) GoString() string
GoString returns the string representation
func (StateMachineListItem) String ¶
func (s StateMachineListItem) String() string
String returns the string representation
type StateMachineStatus ¶
type StateMachineStatus string
const ( StateMachineStatusActive StateMachineStatus = "ACTIVE" StateMachineStatusDeleting StateMachineStatus = "DELETING" )
Enum values for StateMachineStatus
func (StateMachineStatus) MarshalValue ¶ added in v0.3.0
func (enum StateMachineStatus) MarshalValue() (string, error)
func (StateMachineStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StateMachineStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StopExecutionInput ¶
type StopExecutionInput struct { // A more detailed explanation of the cause of the termination. Cause *string `locationName:"cause" type:"string"` // An arbitrary error code that identifies the cause of the termination. Error *string `locationName:"error" type:"string"` // The Amazon Resource Name (ARN) of the execution to stop. // // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionInput
func (StopExecutionInput) GoString ¶
func (s StopExecutionInput) GoString() string
GoString returns the string representation
func (StopExecutionInput) String ¶
func (s StopExecutionInput) String() string
String returns the string representation
func (*StopExecutionInput) Validate ¶
func (s *StopExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopExecutionOutput ¶
type StopExecutionOutput struct { // The date the execution is stopped. // // StopDate is a required field StopDate *time.Time `locationName:"stopDate" type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionOutput
func (StopExecutionOutput) GoString ¶
func (s StopExecutionOutput) GoString() string
GoString returns the string representation
func (StopExecutionOutput) SDKResponseMetadata ¶
func (s StopExecutionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StopExecutionOutput) String ¶
func (s StopExecutionOutput) String() string
String returns the string representation
type StopExecutionRequest ¶
type StopExecutionRequest struct { *aws.Request Input *StopExecutionInput Copy func(*StopExecutionInput) StopExecutionRequest }
StopExecutionRequest is a API request type for the StopExecution API operation.
func (StopExecutionRequest) Send ¶
func (r StopExecutionRequest) Send() (*StopExecutionOutput, error)
Send marshals and sends the StopExecution API request.
type UpdateStateMachineInput ¶ added in v0.2.0
type UpdateStateMachineInput struct { // The Amazon States Language definition of the state machine. Definition *string `locationName:"definition" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the IAM role of the state machine. RoleArn *string `locationName:"roleArn" min:"1" type:"string"` // The Amazon Resource Name (ARN) of the state machine. // // StateMachineArn is a required field StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineInput
func (UpdateStateMachineInput) GoString ¶ added in v0.2.0
func (s UpdateStateMachineInput) GoString() string
GoString returns the string representation
func (UpdateStateMachineInput) String ¶ added in v0.2.0
func (s UpdateStateMachineInput) String() string
String returns the string representation
func (*UpdateStateMachineInput) Validate ¶ added in v0.2.0
func (s *UpdateStateMachineInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStateMachineOutput ¶ added in v0.2.0
type UpdateStateMachineOutput struct { // The date and time the state machine was updated. // // UpdateDate is a required field UpdateDate *time.Time `locationName:"updateDate" type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineOutput
func (UpdateStateMachineOutput) GoString ¶ added in v0.2.0
func (s UpdateStateMachineOutput) GoString() string
GoString returns the string representation
func (UpdateStateMachineOutput) SDKResponseMetadata ¶ added in v0.2.0
func (s UpdateStateMachineOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateStateMachineOutput) String ¶ added in v0.2.0
func (s UpdateStateMachineOutput) String() string
String returns the string representation
type UpdateStateMachineRequest ¶ added in v0.2.0
type UpdateStateMachineRequest struct { *aws.Request Input *UpdateStateMachineInput Copy func(*UpdateStateMachineInput) UpdateStateMachineRequest }
UpdateStateMachineRequest is a API request type for the UpdateStateMachine API operation.
func (UpdateStateMachineRequest) Send ¶ added in v0.2.0
func (r UpdateStateMachineRequest) Send() (*UpdateStateMachineOutput, error)
Send marshals and sends the UpdateStateMachine API request.