1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package swf 4 5import ( 6 "context" 7 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 8 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 9 "github.com/aws/aws-sdk-go-v2/service/swf/types" 10 "github.com/aws/smithy-go/middleware" 11 smithyhttp "github.com/aws/smithy-go/transport/http" 12) 13 14// Deprecates the specified workflow type. After a workflow type has been 15// deprecated, you cannot create new executions of that type. Executions that were 16// started before the type was deprecated continues to run. A deprecated workflow 17// type may still be used when calling visibility actions. This operation is 18// eventually consistent. The results are best effort and may not exactly reflect 19// recent updates and changes. Access Control You can use IAM policies to control 20// this action's access to Amazon SWF resources as follows: 21// 22// * Use a Resource 23// element with the domain name to limit the action to only specified domains. 24// 25// * 26// Use an Action element to allow or deny permission to call this action. 27// 28// * 29// Constrain the following parameters by using a Condition element with the 30// appropriate keys. 31// 32// * workflowType.name: String constraint. The key is 33// swf:workflowType.name. 34// 35// * workflowType.version: String constraint. The key is 36// swf:workflowType.version. 37// 38// If the caller doesn't have sufficient permissions to 39// invoke the action, or the parameter values fall outside the specified 40// constraints, the action fails. The associated event attribute's cause parameter 41// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see 42// Using IAM to Manage Access to Amazon SWF Workflows 43// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) 44// in the Amazon SWF Developer Guide. 45func (c *Client) DeprecateWorkflowType(ctx context.Context, params *DeprecateWorkflowTypeInput, optFns ...func(*Options)) (*DeprecateWorkflowTypeOutput, error) { 46 if params == nil { 47 params = &DeprecateWorkflowTypeInput{} 48 } 49 50 result, metadata, err := c.invokeOperation(ctx, "DeprecateWorkflowType", params, optFns, addOperationDeprecateWorkflowTypeMiddlewares) 51 if err != nil { 52 return nil, err 53 } 54 55 out := result.(*DeprecateWorkflowTypeOutput) 56 out.ResultMetadata = metadata 57 return out, nil 58} 59 60type DeprecateWorkflowTypeInput struct { 61 62 // The name of the domain in which the workflow type is registered. 63 // 64 // This member is required. 65 Domain *string 66 67 // The workflow type to deprecate. 68 // 69 // This member is required. 70 WorkflowType *types.WorkflowType 71} 72 73type DeprecateWorkflowTypeOutput struct { 74 // Metadata pertaining to the operation's result. 75 ResultMetadata middleware.Metadata 76} 77 78func addOperationDeprecateWorkflowTypeMiddlewares(stack *middleware.Stack, options Options) (err error) { 79 err = stack.Serialize.Add(&awsAwsjson10_serializeOpDeprecateWorkflowType{}, middleware.After) 80 if err != nil { 81 return err 82 } 83 err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDeprecateWorkflowType{}, middleware.After) 84 if err != nil { 85 return err 86 } 87 if err = addSetLoggerMiddleware(stack, options); err != nil { 88 return err 89 } 90 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 91 return err 92 } 93 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 94 return err 95 } 96 if err = addResolveEndpointMiddleware(stack, options); err != nil { 97 return err 98 } 99 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 100 return err 101 } 102 if err = addRetryMiddlewares(stack, options); err != nil { 103 return err 104 } 105 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 106 return err 107 } 108 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 109 return err 110 } 111 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 112 return err 113 } 114 if err = addClientUserAgent(stack); err != nil { 115 return err 116 } 117 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 118 return err 119 } 120 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 121 return err 122 } 123 if err = addOpDeprecateWorkflowTypeValidationMiddleware(stack); err != nil { 124 return err 125 } 126 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeprecateWorkflowType(options.Region), middleware.Before); err != nil { 127 return err 128 } 129 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 130 return err 131 } 132 if err = addResponseErrorMiddleware(stack); err != nil { 133 return err 134 } 135 if err = addRequestResponseLogging(stack, options); err != nil { 136 return err 137 } 138 return nil 139} 140 141func newServiceMetadataMiddleware_opDeprecateWorkflowType(region string) *awsmiddleware.RegisterServiceMetadata { 142 return &awsmiddleware.RegisterServiceMetadata{ 143 Region: region, 144 ServiceID: ServiceID, 145 SigningName: "swf", 146 OperationName: "DeprecateWorkflowType", 147 } 148} 149