-
Notifications
You must be signed in to change notification settings - Fork 596
/
api_op_GetMaintenanceWindowTask.go
227 lines (196 loc) · 7.84 KB
/
api_op_GetMaintenanceWindowTask.go
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
// 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/service/ssm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the details of a maintenance window task.
//
// For maintenance window tasks without a specified target, you can't supply
// values for --max-errors and --max-concurrency . Instead, the system inserts a
// placeholder value of 1 , which may be reported in the response to this command.
// These values don't affect the running of your task and can be ignored.
//
// To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
func (c *Client) GetMaintenanceWindowTask(ctx context.Context, params *GetMaintenanceWindowTaskInput, optFns ...func(*Options)) (*GetMaintenanceWindowTaskOutput, error) {
if params == nil {
params = &GetMaintenanceWindowTaskInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetMaintenanceWindowTask", params, optFns, c.addOperationGetMaintenanceWindowTaskMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetMaintenanceWindowTaskOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetMaintenanceWindowTaskInput struct {
// The maintenance window ID that includes the task to retrieve.
//
// This member is required.
WindowId *string
// The maintenance window task ID to retrieve.
//
// This member is required.
WindowTaskId *string
noSmithyDocumentSerde
}
type GetMaintenanceWindowTaskOutput struct {
// The details for the CloudWatch alarm you applied to your maintenance window
// task.
AlarmConfiguration *types.AlarmConfiguration
// The action to take on tasks when the maintenance window cutoff time is reached.
// CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step
// Functions tasks, CANCEL_TASK means that currently running task invocations
// continue, but no new task invocations are started. For Run Command tasks,
// CANCEL_TASK means the system attempts to stop the task by sending a
// CancelCommand operation.
CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior
// The retrieved task description.
Description *string
// The location in Amazon Simple Storage Service (Amazon S3) where the task
// results are logged.
//
// LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service
// (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and
// OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
// information about how Amazon Web Services Systems Manager handles these options
// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
LoggingInfo *types.LoggingInfo
// The maximum number of targets allowed to run this task in parallel.
//
// For maintenance window tasks without a target specified, you can't supply a
// value for this option. Instead, the system inserts a placeholder value of 1 ,
// which may be reported in the response to this command. This value doesn't affect
// the running of your task and can be ignored.
MaxConcurrency *string
// The maximum number of errors allowed before the task stops being scheduled.
//
// For maintenance window tasks without a target specified, you can't supply a
// value for this option. Instead, the system inserts a placeholder value of 1 ,
// which may be reported in the response to this command. This value doesn't affect
// the running of your task and can be ignored.
MaxErrors *string
// The retrieved task name.
Name *string
// The priority of the task when it runs. The lower the number, the higher the
// priority. Tasks that have the same priority are scheduled in parallel.
Priority int32
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
// service role to use to publish Amazon Simple Notification Service (Amazon SNS)
// notifications for maintenance window Run Command tasks.
ServiceRoleArn *string
// The targets where the task should run.
Targets []types.Target
// The resource that the task used during execution. For RUN_COMMAND and AUTOMATION
// task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA
// tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value
// is the state machine ARN.
TaskArn *string
// The parameters to pass to the task when it runs.
TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
// The parameters to pass to the task when it runs.
//
// TaskParameters has been deprecated. To specify parameters to pass to a task
// when it runs, instead use the Parameters option in the TaskInvocationParameters
// structure. For information about how Systems Manager handles these options for
// the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression
// The type of task to run.
TaskType types.MaintenanceWindowTaskType
// The retrieved maintenance window ID.
WindowId *string
// The retrieved maintenance window task ID.
WindowTaskId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetMaintenanceWindowTaskMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetMaintenanceWindowTask{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetMaintenanceWindowTask{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetMaintenanceWindowTask"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addOpGetMaintenanceWindowTaskValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetMaintenanceWindowTask(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opGetMaintenanceWindowTask(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetMaintenanceWindowTask",
}
}