AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeStateMachineOutput

import "github.com/aws/aws-sdk-go/service/sfn"

type DescribeStateMachineOutput struct { CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"` Name *string `locationName:"name" min:"1" type:"string" required:"true"` RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` Status *string `locationName:"status" type:"string" enum:"StateMachineStatus"` }

CreationDate

Type: *time.Time

The date the state machine is created.

CreationDate is a required field

Definition

Type: *string

The Amazon States Language definition of the state machine. See Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).

Definition is a required field

Name

Type: *string

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

RoleArn

Type: *string

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)

RoleArn is a required field

StateMachineArn

Type: *string

The Amazon Resource Name (ARN) that identifies the state machine.

StateMachineArn is a required field

Status

Type: *string

The current status of the state machine.

Method

GoString

func (s DescribeStateMachineOutput) GoString() string

GoString returns the string representation

SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

SetDefinition

func (s *DescribeStateMachineOutput) SetDefinition(v string) *DescribeStateMachineOutput

SetDefinition sets the Definition field's value.

SetName

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

SetName sets the Name field's value.

SetRoleArn

func (s *DescribeStateMachineOutput) SetRoleArn(v string) *DescribeStateMachineOutput

SetRoleArn sets the RoleArn field's value.

SetStateMachineArn

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

SetStateMachineArn sets the StateMachineArn field's value.

SetStatus

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

SetStatus sets the Status field's value.

String

func (s DescribeStateMachineOutput) String() string

String returns the string representation

On this page: