1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package sfn
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/sfn/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Describes a state machine. This operation is eventually consistent. The results
// are best effort and may not reflect very recent updates and changes.
func (c *Client) DescribeStateMachine(ctx context.Context, params *DescribeStateMachineInput, optFns ...func(*Options)) (*DescribeStateMachineOutput, error) {
if params == nil {
params = &DescribeStateMachineInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeStateMachine", params, optFns, c.addOperationDescribeStateMachineMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeStateMachineOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeStateMachineInput struct {
// The Amazon Resource Name (ARN) of the state machine to describe.
//
// This member is required.
StateMachineArn *string
noSmithyDocumentSerde
}
type DescribeStateMachineOutput struct {
// The date the state machine is created.
//
// This member is required.
CreationDate *time.Time
// 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).
//
// This member is required.
Definition *string
// The name of the state machine. A name must not contain:
//
// * white space
//
// *
// brackets < > { } [ ]
//
// * wildcard characters ? *
//
// * special characters " # % \ ^
// | ~ ` $ & , ; : /
//
// * control characters (U+0000-001F, U+007F-009F)
//
// To enable
// logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and
// _.
//
// This member is required.
Name *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.)
//
// This member is required.
RoleArn *string
// The Amazon Resource Name (ARN) that identifies the state machine.
//
// This member is required.
StateMachineArn *string
// The type of the state machine (STANDARD or EXPRESS).
//
// This member is required.
Type types.StateMachineType
// The LoggingConfiguration data type is used to set CloudWatch Logs options.
LoggingConfiguration *types.LoggingConfiguration
// The current status of the state machine.
Status types.StateMachineStatus
// Selects whether AWS X-Ray tracing is enabled.
TracingConfiguration *types.TracingConfiguration
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeStateMachineMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson10_serializeOpDescribeStateMachine{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDescribeStateMachine{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeStateMachineValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeStateMachine(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeStateMachine(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "states",
OperationName: "DescribeStateMachine",
}
}
|