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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package sfn
import (
"context"
"fmt"
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"
)
// Provides information about a Map Run's configuration, progress, and results. If
// you've redriven (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html)
// a Map Run, this API action also returns information about the redrives of that
// Map Run. For more information, see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html)
// in the Step Functions Developer Guide.
func (c *Client) DescribeMapRun(ctx context.Context, params *DescribeMapRunInput, optFns ...func(*Options)) (*DescribeMapRunOutput, error) {
if params == nil {
params = &DescribeMapRunInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeMapRun", params, optFns, c.addOperationDescribeMapRunMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeMapRunOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeMapRunInput struct {
// The Amazon Resource Name (ARN) that identifies a Map Run.
//
// This member is required.
MapRunArn *string
noSmithyDocumentSerde
}
type DescribeMapRunOutput struct {
// The Amazon Resource Name (ARN) that identifies the execution in which the Map
// Run was started.
//
// This member is required.
ExecutionArn *string
// A JSON object that contains information about the total number of child
// workflow executions for the Map Run, and the count of child workflow executions
// for each status, such as failed and succeeded .
//
// This member is required.
ExecutionCounts *types.MapRunExecutionCounts
// A JSON object that contains information about the total number of items, and
// the item count for each processing status, such as pending and failed .
//
// This member is required.
ItemCounts *types.MapRunItemCounts
// The Amazon Resource Name (ARN) that identifies a Map Run.
//
// This member is required.
MapRunArn *string
// The maximum number of child workflow executions configured to run in parallel
// for the Map Run at the same time.
//
// This member is required.
MaxConcurrency int32
// The date when the Map Run was started.
//
// This member is required.
StartDate *time.Time
// The current status of the Map Run.
//
// This member is required.
Status types.MapRunStatus
// The maximum number of failed child workflow executions before the Map Run fails.
//
// This member is required.
ToleratedFailureCount int64
// The maximum percentage of failed child workflow executions before the Map Run
// fails.
//
// This member is required.
ToleratedFailurePercentage float32
// The number of times you've redriven a Map Run. If you have not yet redriven a
// Map Run, the redriveCount is 0. This count is only updated if you successfully
// redrive a Map Run.
RedriveCount *int32
// The date a Map Run was last redriven. If you have not yet redriven a Map Run,
// the redriveDate is null.
RedriveDate *time.Time
// The date when the Map Run was stopped.
StopDate *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeMapRunMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpDescribeMapRun{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDescribeMapRun{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeMapRun"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeMapRunValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeMapRun(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeMapRun(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeMapRun",
}
}
|