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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package ssm
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/ssm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a change request for Change Manager. The Automation runbooks specified
// in the change request run only after all required approvals for the change
// request have been received.
func (c *Client) StartChangeRequestExecution(ctx context.Context, params *StartChangeRequestExecutionInput, optFns ...func(*Options)) (*StartChangeRequestExecutionOutput, error) {
if params == nil {
params = &StartChangeRequestExecutionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartChangeRequestExecution", params, optFns, c.addOperationStartChangeRequestExecutionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartChangeRequestExecutionOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartChangeRequestExecutionInput struct {
// The name of the change template document to run during the runbook workflow.
//
// This member is required.
DocumentName *string
// Information about the Automation runbooks that are run during the runbook
// workflow. The Automation runbooks specified for the runbook workflow can't run
// until all required approvals for the change request have been received.
//
// This member is required.
Runbooks []types.Runbook
// Indicates whether the change request can be approved automatically without the
// need for manual approvals. If AutoApprovable is enabled in a change template,
// then setting AutoApprove to true in StartChangeRequestExecution creates a
// change request that bypasses approver review. Change Calendar restrictions are
// not bypassed in this scenario. If the state of an associated calendar is CLOSED
// , change freeze approvers must still grant permission for this change request to
// run. If they don't, the change won't be processed until the calendar state is
// again OPEN .
AutoApprove bool
// User-provided details about the change. If no details are provided, content
// specified in the Template information section of the associated change template
// is added.
ChangeDetails *string
// The name of the change request associated with the runbook workflow to be run.
ChangeRequestName *string
// The user-provided idempotency token. The token must be unique, is case
// insensitive, enforces the UUID format, and can't be reused.
ClientToken *string
// The version of the change template document to run during the runbook workflow.
DocumentVersion *string
// A key-value map of parameters that match the declared parameters in the change
// template document.
Parameters map[string][]string
// The time that the requester expects the runbook workflow related to the change
// request to complete. The time is an estimate only that the requester provides
// for reviewers.
ScheduledEndTime *time.Time
// The date and time specified in the change request to run the Automation
// runbooks. The Automation runbooks specified for the runbook workflow can't run
// until all required approvals for the change request have been received.
ScheduledTime *time.Time
// Optional metadata that you assign to a resource. You can specify a maximum of
// five tags for a change request. Tags enable you to categorize a resource in
// different ways, such as by purpose, owner, or environment. For example, you
// might want to tag a change request to identify an environment or target Amazon
// Web Services Region. In this case, you could specify the following key-value
// pairs:
// - Key=Environment,Value=Production
// - Key=Region,Value=us-east-2
Tags []types.Tag
noSmithyDocumentSerde
}
type StartChangeRequestExecutionOutput struct {
// The unique ID of a runbook workflow operation. (A runbook workflow is a type of
// Automation operation.)
AutomationExecutionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartChangeRequestExecutionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpStartChangeRequestExecution{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStartChangeRequestExecution{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartChangeRequestExecution"); 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 = addOpStartChangeRequestExecutionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartChangeRequestExecution(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_opStartChangeRequestExecution(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartChangeRequestExecution",
}
}
|
