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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package scheduler
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/scheduler/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Updates the specified schedule. When you call UpdateSchedule , EventBridge
// Scheduler uses all values, including empty values, specified in the request and
// overrides the existing schedule. This is by design. This means that if you do
// not set an optional field in your request, that field will be set to its
// system-default value after the update. Before calling this operation, we
// recommend that you call the GetSchedule API operation and make a note of all
// optional parameters for your UpdateSchedule call.
func (c *Client) UpdateSchedule(ctx context.Context, params *UpdateScheduleInput, optFns ...func(*Options)) (*UpdateScheduleOutput, error) {
if params == nil {
params = &UpdateScheduleInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateSchedule", params, optFns, c.addOperationUpdateScheduleMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateScheduleOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateScheduleInput struct {
// Allows you to configure a time window during which EventBridge Scheduler
// invokes the schedule.
//
// This member is required.
FlexibleTimeWindow *types.FlexibleTimeWindow
// The name of the schedule that you are updating.
//
// This member is required.
Name *string
// The expression that defines when the schedule runs. The following formats are
// supported.
// - at expression - at(yyyy-mm-ddThh:mm:ss)
// - rate expression - rate(value unit)
// - cron expression - cron(fields)
// You can use at expressions to create one-time schedules that invoke a target
// once, at the time and in the time zone, that you specify. You can use rate and
// cron expressions to create recurring schedules. Rate-based schedules are useful
// when you want to invoke a target at regular intervals, such as every 15 minutes
// or every five days. Cron-based schedules are useful when you want to invoke a
// target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day
// of the month. A cron expression consists of six fields separated by white
// spaces: (minutes hours day_of_month month day_of_week year) . A rate expression
// consists of a value as a positive integer, and a unit with the following
// options: minute | minutes | hour | hours | day | days For more information and
// examples, see Schedule types on EventBridge Scheduler (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html)
// in the EventBridge Scheduler User Guide.
//
// This member is required.
ScheduleExpression *string
// The schedule target. You can use this operation to change the target that your
// schedule invokes.
//
// This member is required.
Target *types.Target
// Specifies the action that EventBridge Scheduler applies to the schedule after
// the schedule completes invoking the target.
ActionAfterCompletion types.ActionAfterCompletion
// Unique, case-sensitive identifier you provide to ensure the idempotency of the
// request. If you do not specify a client token, EventBridge Scheduler uses a
// randomly generated token for the request to ensure idempotency.
ClientToken *string
// The description you specify for the schedule.
Description *string
// The date, in UTC, before which the schedule can invoke its target. Depending on
// the schedule's recurrence expression, invocations might stop on, or before, the
// EndDate you specify. EventBridge Scheduler ignores EndDate for one-time
// schedules.
EndDate *time.Time
// The name of the schedule group with which the schedule is associated. You must
// provide this value in order for EventBridge Scheduler to find the schedule you
// want to update. If you omit this value, EventBridge Scheduler assumes the group
// is associated to the default group.
GroupName *string
// The ARN for the customer managed KMS key that that you want EventBridge
// Scheduler to use to encrypt and decrypt your data.
KmsKeyArn *string
// The timezone in which the scheduling expression is evaluated.
ScheduleExpressionTimezone *string
// The date, in UTC, after which the schedule can begin invoking its target.
// Depending on the schedule's recurrence expression, invocations might occur on,
// or after, the StartDate you specify. EventBridge Scheduler ignores StartDate
// for one-time schedules.
StartDate *time.Time
// Specifies whether the schedule is enabled or disabled.
State types.ScheduleState
noSmithyDocumentSerde
}
type UpdateScheduleOutput struct {
// The Amazon Resource Name (ARN) of the schedule that you updated.
//
// This member is required.
ScheduleArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateSchedule{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateSchedule{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateSchedule"); 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 = addIdempotencyToken_opUpdateScheduleMiddleware(stack, options); err != nil {
return err
}
if err = addOpUpdateScheduleValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateSchedule(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
}
type idempotencyToken_initializeOpUpdateSchedule struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpUpdateSchedule) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpUpdateSchedule) 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.(*UpdateScheduleInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *UpdateScheduleInput ")
}
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_opUpdateScheduleMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpUpdateSchedule{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opUpdateSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateSchedule",
}
}
|