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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
// 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"
)
// Adds a new task to a maintenance window.
func (c *Client) RegisterTaskWithMaintenanceWindow(ctx context.Context, params *RegisterTaskWithMaintenanceWindowInput, optFns ...func(*Options)) (*RegisterTaskWithMaintenanceWindowOutput, error) {
if params == nil {
params = &RegisterTaskWithMaintenanceWindowInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RegisterTaskWithMaintenanceWindow", params, optFns, c.addOperationRegisterTaskWithMaintenanceWindowMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RegisterTaskWithMaintenanceWindowOutput)
out.ResultMetadata = metadata
return out, nil
}
type RegisterTaskWithMaintenanceWindowInput struct {
// The ARN of the task to run.
//
// This member is required.
TaskArn *string
// The type of task being registered.
//
// This member is required.
TaskType types.MaintenanceWindowTaskType
// The ID of the maintenance window the task should be added to.
//
// This member is required.
WindowId *string
// The CloudWatch alarm you want to apply to your maintenance window task.
AlarmConfiguration *types.AlarmConfiguration
// User-provided idempotency token.
ClientToken *string
// Indicates whether tasks should continue to run after the cutoff time specified
// in the maintenance windows is reached.
//
// * CONTINUE_TASK: When the cutoff time is
// reached, any tasks that are running continue. The default value.
//
// *
// CANCEL_TASK:
//
// * For Automation, Lambda, Step Functions tasks: When the cutoff
// time is reached, any task invocations that are already running continue, but no
// new task invocations are started.
//
// * For Run Command tasks: When the cutoff time
// is reached, the system sends a CancelCommand operation that attempts to cancel
// the command associated with the task. However, there is no guarantee that the
// command will be terminated and the underlying process stopped.
//
// The status for
// tasks that are not completed is TIMED_OUT.
CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior
// An optional description for the task.
Description *string
// A structure containing information about an Amazon Simple Storage Service
// (Amazon S3) bucket to write managed node-level logs to. 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 this task can be run for, in parallel. Although
// this element is listed as "Required: No", a value can be omitted only when you
// are registering or updating a targetless task
// (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// You must provide a value in all other cases. 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. This value doesn't affect the
// running of your task.
MaxConcurrency *string
// The maximum number of errors allowed before this task stops being scheduled.
// Although this element is listed as "Required: No", a value can be omitted only
// when you are registering or updating a targetless task
// (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// You must provide a value in all other cases. 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. This value doesn't affect the
// running of your task.
MaxErrors *string
// An optional name for the task.
Name *string
// The priority of the task in the maintenance window, the lower the number the
// higher the priority. Tasks in a maintenance window are scheduled in priority
// order with tasks that have the same priority scheduled in parallel.
Priority *int32
// The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services
// Systems Manager to assume when running a maintenance window task. If you do not
// specify a service role ARN, Systems Manager uses your account's service-linked
// role. If no service-linked role for Systems Manager exists in your account, it
// is created when you run RegisterTaskWithMaintenanceWindow. For more information,
// see the following topics in the in the Amazon Web Services Systems Manager User
// Guide:
//
// * Using service-linked roles for Systems Manager
// (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions)
//
// *
// Should I use a service-linked role or a custom service role to run maintenance
// window tasks?
// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
ServiceRoleArn *string
// The targets (either managed nodes or maintenance window targets). One or more
// targets must be specified for maintenance window Run Command-type tasks.
// Depending on the task, targets are optional for other maintenance window task
// types (Automation, Lambda, and Step Functions). For more information about
// running tasks that don't specify targets, see Registering maintenance window
// tasks without targets
// (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// in the Amazon Web Services Systems Manager User Guide. Specify managed nodes
// using the following format: Key=InstanceIds,Values=, Specify maintenance window
// targets using the following format: Key=WindowTargetIds,Values=,
Targets []types.Target
// The parameters that the task should use during execution. Populate only the
// fields that match the task type. All other fields should be empty.
TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
// The parameters that should be passed to the task when it is run. 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
noSmithyDocumentSerde
}
type RegisterTaskWithMaintenanceWindowOutput struct {
// The ID of the task in the maintenance window.
WindowTaskId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRegisterTaskWithMaintenanceWindowMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpRegisterTaskWithMaintenanceWindow{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpRegisterTaskWithMaintenanceWindow{}, 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 = addIdempotencyToken_opRegisterTaskWithMaintenanceWindowMiddleware(stack, options); err != nil {
return err
}
if err = addOpRegisterTaskWithMaintenanceWindowValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRegisterTaskWithMaintenanceWindow(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
}
type idempotencyToken_initializeOpRegisterTaskWithMaintenanceWindow struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpRegisterTaskWithMaintenanceWindow) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpRegisterTaskWithMaintenanceWindow) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*RegisterTaskWithMaintenanceWindowInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *RegisterTaskWithMaintenanceWindowInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opRegisterTaskWithMaintenanceWindowMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpRegisterTaskWithMaintenanceWindow{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opRegisterTaskWithMaintenanceWindow(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ssm",
OperationName: "RegisterTaskWithMaintenanceWindow",
}
}
|