@aws-sdk/client-scheduler 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/Scheduler.d.ts +3 -1
- package/dist-types/SchedulerClient.d.ts +1 -1
- package/dist-types/commands/CreateScheduleCommand.d.ts +2 -1
- package/dist-types/commands/CreateScheduleGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteScheduleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteScheduleGroupCommand.d.ts +2 -1
- package/dist-types/commands/GetScheduleCommand.d.ts +2 -1
- package/dist-types/commands/GetScheduleGroupCommand.d.ts +2 -1
- package/dist-types/commands/ListScheduleGroupsCommand.d.ts +2 -1
- package/dist-types/commands/ListSchedulesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScheduleCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +165 -165
- package/dist-types/ts3.4/Scheduler.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateScheduleGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteScheduleGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetScheduleGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListScheduleGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSchedulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateScheduleCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -25,8 +25,8 @@ export declare const AssignPublicIp: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp];
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>Unexpected error encountered while processing the request.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
export declare class InternalServerException extends __BaseException {
|
|
32
32
|
readonly name: "InternalServerException";
|
|
@@ -42,24 +42,24 @@ export declare class InternalServerException extends __BaseException {
|
|
|
42
42
|
*/
|
|
43
43
|
export interface ListTagsForResourceInput {
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The ARN of the EventBridge Scheduler resource for which you want to view tags.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
ResourceArn: string | undefined;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>Tag to associate with a schedule group.</p>
|
|
52
|
+
* @public
|
|
53
53
|
*/
|
|
54
54
|
export interface Tag {
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>The key for the tag.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
Key: string | undefined;
|
|
60
60
|
/**
|
|
61
|
-
* @public
|
|
62
61
|
* <p>The value for the tag.</p>
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
Value: string | undefined;
|
|
65
65
|
}
|
|
@@ -68,14 +68,14 @@ export interface Tag {
|
|
|
68
68
|
*/
|
|
69
69
|
export interface ListTagsForResourceOutput {
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The list of tags associated with the specified resource.</p>
|
|
72
|
+
* @public
|
|
73
73
|
*/
|
|
74
74
|
Tags?: Tag[];
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The request references a resource which does not exist.</p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
81
81
|
readonly name: "ResourceNotFoundException";
|
|
@@ -87,8 +87,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
87
87
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The request was denied due to request throttling.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export declare class ThrottlingException extends __BaseException {
|
|
94
94
|
readonly name: "ThrottlingException";
|
|
@@ -100,8 +100,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
100
100
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
|
-
* @public
|
|
104
103
|
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export declare class ValidationException extends __BaseException {
|
|
107
107
|
readonly name: "ValidationException";
|
|
@@ -113,8 +113,8 @@ export declare class ValidationException extends __BaseException {
|
|
|
113
113
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
114
114
|
}
|
|
115
115
|
/**
|
|
116
|
-
* @public
|
|
117
116
|
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
117
|
+
* @public
|
|
118
118
|
*/
|
|
119
119
|
export declare class ConflictException extends __BaseException {
|
|
120
120
|
readonly name: "ConflictException";
|
|
@@ -138,18 +138,18 @@ export declare const FlexibleTimeWindowMode: {
|
|
|
138
138
|
*/
|
|
139
139
|
export type FlexibleTimeWindowMode = (typeof FlexibleTimeWindowMode)[keyof typeof FlexibleTimeWindowMode];
|
|
140
140
|
/**
|
|
141
|
-
* @public
|
|
142
141
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
142
|
+
* @public
|
|
143
143
|
*/
|
|
144
144
|
export interface FlexibleTimeWindow {
|
|
145
145
|
/**
|
|
146
|
-
* @public
|
|
147
146
|
* <p>Determines whether the schedule is invoked within a flexible time window.</p>
|
|
147
|
+
* @public
|
|
148
148
|
*/
|
|
149
149
|
Mode: FlexibleTimeWindowMode | undefined;
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>The maximum time window during which a schedule can be invoked.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
MaximumWindowInMinutes?: number;
|
|
155
155
|
}
|
|
@@ -166,36 +166,36 @@ export declare const ScheduleState: {
|
|
|
166
166
|
*/
|
|
167
167
|
export type ScheduleState = (typeof ScheduleState)[keyof typeof ScheduleState];
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
export interface DeadLetterConfig {
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.</p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
Arn?: string;
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The details of a capacity provider strategy.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
export interface CapacityProviderStrategyItem {
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The short name of the capacity provider.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
capacityProvider: string | undefined;
|
|
189
189
|
/**
|
|
190
|
-
* @public
|
|
191
190
|
* <p>The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the
|
|
192
191
|
* base value, if defined, is satisfied.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
weight?: number;
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
|
|
198
197
|
* If no value is specified, the default value of <code>0</code> is used.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
base?: number;
|
|
201
201
|
}
|
|
@@ -213,35 +213,35 @@ export declare const LaunchType: {
|
|
|
213
213
|
*/
|
|
214
214
|
export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
export interface AwsVpcConfiguration {
|
|
220
220
|
/**
|
|
221
|
-
* @public
|
|
222
221
|
* <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</p>
|
|
222
|
+
* @public
|
|
223
223
|
*/
|
|
224
224
|
Subnets: string[] | undefined;
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups.
|
|
228
227
|
* If you do not specify a security group, the default security group for the VPC is used.</p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
SecurityGroups?: string[];
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
|
|
233
|
+
* @public
|
|
234
234
|
*/
|
|
235
235
|
AssignPublicIp?: AssignPublicIp;
|
|
236
236
|
}
|
|
237
237
|
/**
|
|
238
|
-
* @public
|
|
239
238
|
* <p>Specifies the network configuration for an ECS task.</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
export interface NetworkConfiguration {
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
awsvpcConfiguration?: AwsVpcConfiguration;
|
|
247
247
|
}
|
|
@@ -258,19 +258,19 @@ export declare const PlacementConstraintType: {
|
|
|
258
258
|
*/
|
|
259
259
|
export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType];
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>An object representing a constraint on task placement.</p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
export interface PlacementConstraint {
|
|
265
265
|
/**
|
|
266
|
-
* @public
|
|
267
266
|
* <p>The type of constraint. Use <code>distinctInstance</code> to ensure that each task in a particular group is running on a different container instance. Use <code>memberOf</code> to restrict the selection to a group of valid candidates.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
type?: PlacementConstraintType;
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is <code>distinctInstance</code>.
|
|
273
272
|
* For more information, see <a href="https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html">Cluster query language</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
expression?: string;
|
|
276
276
|
}
|
|
@@ -288,22 +288,22 @@ export declare const PlacementStrategyType: {
|
|
|
288
288
|
*/
|
|
289
289
|
export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof PlacementStrategyType];
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The task placement strategy for a task or service.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
export interface PlacementStrategy {
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates
|
|
298
297
|
* evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter.
|
|
299
298
|
* For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).</p>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
type?: PlacementStrategyType;
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>The field to apply the placement strategy against. For the spread placement strategy, valid values are <code>instanceId</code> (or <code>instanceId</code>, which has the same effect),
|
|
305
304
|
* or any platform or custom attribute that is applied to a container instance, such as <code>attribute:ecs.availability-zone</code>. For the binpack placement strategy, valid values are
|
|
306
305
|
* <code>cpu</code> and <code>memory</code>. For the random placement strategy, this field is not used.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
field?: string;
|
|
309
309
|
}
|
|
@@ -319,174 +319,173 @@ export declare const PropagateTags: {
|
|
|
319
319
|
*/
|
|
320
320
|
export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
|
|
321
321
|
/**
|
|
322
|
-
* @public
|
|
323
322
|
* <p>The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
|
|
324
323
|
* <code>RunTask</code>
|
|
325
324
|
* </a> API operation.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
export interface EcsParameters {
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
TaskDefinitionArn: string | undefined;
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
TaskCount?: number;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task.
|
|
341
340
|
* The <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS is supported.
|
|
342
341
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html">AWS Fargate on Amazon ECS</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
342
|
+
* @public
|
|
343
343
|
*/
|
|
344
344
|
LaunchType?: LaunchType;
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>This structure specifies the network configuration for an ECS task.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
NetworkConfiguration?: NetworkConfiguration;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>.</p>
|
|
352
|
+
* @public
|
|
353
353
|
*/
|
|
354
354
|
PlatformVersion?: string;
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
Group?: string;
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>The capacity provider strategy to use for the task.</p>
|
|
362
|
+
* @public
|
|
363
363
|
*/
|
|
364
364
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
365
365
|
/**
|
|
366
|
-
* @public
|
|
367
366
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a>
|
|
368
367
|
* in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
EnableECSManagedTags?: boolean;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
EnableExecuteCommand?: boolean;
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).</p>
|
|
378
|
+
* @public
|
|
379
379
|
*/
|
|
380
380
|
PlacementConstraints?: PlacementConstraint[];
|
|
381
381
|
/**
|
|
382
|
-
* @public
|
|
383
382
|
* <p>The task placement strategy for a task or service.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
PlacementStrategy?: PlacementStrategy[];
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated.
|
|
389
388
|
* Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html">
|
|
390
389
|
* <code>TagResource</code>
|
|
391
390
|
* </a>
|
|
392
391
|
* API action.
|
|
393
392
|
* </p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
PropagateTags?: PropagateTags;
|
|
396
396
|
/**
|
|
397
|
-
* @public
|
|
398
397
|
* <p>The reference ID to use for the task.</p>
|
|
398
|
+
* @public
|
|
399
399
|
*/
|
|
400
400
|
ReferenceId?: string;
|
|
401
401
|
/**
|
|
402
|
-
* @public
|
|
403
402
|
* <p>The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
|
|
404
403
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
|
|
405
404
|
* <code>RunTask</code>
|
|
406
405
|
* </a> in the <i>Amazon ECS API Reference</i>.</p>
|
|
406
|
+
* @public
|
|
407
407
|
*/
|
|
408
408
|
Tags?: Record<string, string>[];
|
|
409
409
|
}
|
|
410
410
|
/**
|
|
411
|
-
* @public
|
|
412
411
|
* <p>The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">
|
|
413
412
|
* <code>PutEvents</code>
|
|
414
413
|
* </a> API operation.</p>
|
|
414
|
+
* @public
|
|
415
415
|
*/
|
|
416
416
|
export interface EventBridgeParameters {
|
|
417
417
|
/**
|
|
418
|
-
* @public
|
|
419
418
|
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
DetailType: string | undefined;
|
|
422
422
|
/**
|
|
423
|
-
* @public
|
|
424
423
|
* <p>The source of the event.</p>
|
|
424
|
+
* @public
|
|
425
425
|
*/
|
|
426
426
|
Source: string | undefined;
|
|
427
427
|
}
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html">
|
|
431
430
|
* <code>PutRecord</code>
|
|
432
431
|
* </a> API operation.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
export interface KinesisParameters {
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>Specifies the shard to which EventBridge Scheduler sends the event. For more information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html">Amazon Kinesis Data Streams terminology and concepts</a> in the
|
|
438
437
|
* <i>Amazon Kinesis Streams Developer Guide</i>.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
PartitionKey: string | undefined;
|
|
441
441
|
}
|
|
442
442
|
/**
|
|
443
|
-
* @public
|
|
444
443
|
* <p>A <code>RetryPolicy</code> object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
export interface RetryPolicy {
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
|
|
449
|
+
* @public
|
|
450
450
|
*/
|
|
451
451
|
MaximumEventAgeInSeconds?: number;
|
|
452
452
|
/**
|
|
453
|
-
* @public
|
|
454
453
|
* <p>The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or
|
|
455
454
|
* until the duration of the <code>MaximumEventAgeInSeconds</code> is reached.</p>
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
MaximumRetryAttempts?: number;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
export interface SageMakerPipelineParameter {
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
Name: string | undefined;
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
Value: string | undefined;
|
|
474
474
|
}
|
|
475
475
|
/**
|
|
476
|
-
* @public
|
|
477
476
|
* <p>The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html">
|
|
478
477
|
* <code>StartPipelineExecution</code>
|
|
479
478
|
* </a> API operation.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
export interface SageMakerPipelineParameters {
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>List of parameter names and values to use when executing the SageMaker Model Building Pipeline.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html">
|
|
491
490
|
* <code>SendMessage</code>
|
|
492
491
|
* </a> API operation.
|
|
@@ -494,83 +493,84 @@ export interface SageMakerPipelineParameters {
|
|
|
494
493
|
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the Amazon SQS message deduplication ID</a> in the
|
|
495
494
|
* <i>Amazon SQS Developer Guide</i>.
|
|
496
495
|
* </p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
export interface SqsParameters {
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The FIFO message group ID to use as the target.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
MessageGroupId?: string;
|
|
504
504
|
}
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to
|
|
508
507
|
* invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
export interface Target {
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
Arn: string | undefined;
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
RoleArn: string | undefined;
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
DeadLetterConfig?: DeadLetterConfig;
|
|
526
526
|
/**
|
|
527
|
-
* @public
|
|
528
527
|
* <p>A <code>RetryPolicy</code> object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.</p>
|
|
528
|
+
* @public
|
|
529
529
|
*/
|
|
530
530
|
RetryPolicy?: RetryPolicy;
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target,
|
|
534
533
|
* the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler
|
|
535
534
|
* delivers a default notification to the target.</p>
|
|
535
|
+
* @public
|
|
536
536
|
*/
|
|
537
537
|
Input?: string;
|
|
538
538
|
/**
|
|
539
|
-
* @public
|
|
540
539
|
* <p>The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
|
|
541
540
|
* <code>RunTask</code>
|
|
542
541
|
* </a> API operation.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
EcsParameters?: EcsParameters;
|
|
545
545
|
/**
|
|
546
|
-
* @public
|
|
547
546
|
* <p>The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">
|
|
548
547
|
* <code>PutEvents</code>
|
|
549
548
|
* </a> API operation.</p>
|
|
549
|
+
* @public
|
|
550
550
|
*/
|
|
551
551
|
EventBridgeParameters?: EventBridgeParameters;
|
|
552
552
|
/**
|
|
553
|
-
* @public
|
|
554
553
|
* <p>The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html">
|
|
555
554
|
* <code>PutRecord</code>
|
|
556
555
|
* </a> API operation.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
KinesisParameters?: KinesisParameters;
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html">
|
|
562
561
|
* <code>StartPipelineExecution</code>
|
|
563
562
|
* </a> API operation.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
566
566
|
/**
|
|
567
|
-
* @public
|
|
568
567
|
* <p>The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html">
|
|
569
568
|
* <code>SendMessage</code>
|
|
570
569
|
* </a> API operation.
|
|
571
570
|
* Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
|
|
572
571
|
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the Amazon SQS message deduplication ID</a> in the
|
|
573
572
|
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
SqsParameters?: SqsParameters;
|
|
576
576
|
}
|
|
@@ -579,17 +579,16 @@ export interface Target {
|
|
|
579
579
|
*/
|
|
580
580
|
export interface CreateScheduleInput {
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>The name of the schedule that you are creating.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
Name: string | undefined;
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
GroupName?: string;
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>
|
|
594
593
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
595
594
|
* </p>
|
|
@@ -626,61 +625,62 @@ export interface CreateScheduleInput {
|
|
|
626
625
|
* <p>
|
|
627
626
|
* For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>.
|
|
628
627
|
* </p>
|
|
628
|
+
* @public
|
|
629
629
|
*/
|
|
630
630
|
ScheduleExpression: string | undefined;
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>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 <code>StartDate</code> you specify.
|
|
634
633
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
StartDate?: Date;
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* <p>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 <code>EndDate</code> you specify.
|
|
640
639
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
EndDate?: Date;
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>The description you specify for the schedule.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
Description?: string;
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
ScheduleExpressionTimezone?: string;
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
State?: ScheduleState;
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
KmsKeyArn?: string;
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p>The schedule's target.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
Target: Target | undefined;
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>
|
|
676
675
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
677
676
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
678
677
|
* </p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
ClientToken?: string;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
ActionAfterCompletion?: ActionAfterCompletion;
|
|
686
686
|
}
|
|
@@ -689,14 +689,14 @@ export interface CreateScheduleInput {
|
|
|
689
689
|
*/
|
|
690
690
|
export interface CreateScheduleOutput {
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
ScheduleArn: string | undefined;
|
|
696
696
|
}
|
|
697
697
|
/**
|
|
698
|
-
* @public
|
|
699
698
|
* <p>The request exceeds a service quota.</p>
|
|
699
|
+
* @public
|
|
700
700
|
*/
|
|
701
701
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
702
702
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -712,21 +712,21 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
712
712
|
*/
|
|
713
713
|
export interface DeleteScheduleInput {
|
|
714
714
|
/**
|
|
715
|
-
* @public
|
|
716
715
|
* <p>The name of the schedule to delete.</p>
|
|
716
|
+
* @public
|
|
717
717
|
*/
|
|
718
718
|
Name: string | undefined;
|
|
719
719
|
/**
|
|
720
|
-
* @public
|
|
721
720
|
* <p>The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
GroupName?: string;
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>
|
|
727
726
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
728
727
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
729
728
|
* </p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
ClientToken?: string;
|
|
732
732
|
}
|
|
@@ -740,13 +740,13 @@ export interface DeleteScheduleOutput {
|
|
|
740
740
|
*/
|
|
741
741
|
export interface GetScheduleInput {
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>The name of the schedule to retrieve.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
Name: string | undefined;
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.</p>
|
|
749
|
+
* @public
|
|
750
750
|
*/
|
|
751
751
|
GroupName?: string;
|
|
752
752
|
}
|
|
@@ -755,22 +755,21 @@ export interface GetScheduleInput {
|
|
|
755
755
|
*/
|
|
756
756
|
export interface GetScheduleOutput {
|
|
757
757
|
/**
|
|
758
|
-
* @public
|
|
759
758
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
759
|
+
* @public
|
|
760
760
|
*/
|
|
761
761
|
Arn?: string;
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>The name of the schedule group associated with this schedule.</p>
|
|
764
|
+
* @public
|
|
765
765
|
*/
|
|
766
766
|
GroupName?: string;
|
|
767
767
|
/**
|
|
768
|
-
* @public
|
|
769
768
|
* <p>The name of the schedule.</p>
|
|
769
|
+
* @public
|
|
770
770
|
*/
|
|
771
771
|
Name?: string;
|
|
772
772
|
/**
|
|
773
|
-
* @public
|
|
774
773
|
* <p>
|
|
775
774
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
776
775
|
* </p>
|
|
@@ -807,63 +806,64 @@ export interface GetScheduleOutput {
|
|
|
807
806
|
* <p>
|
|
808
807
|
* For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>.
|
|
809
808
|
* </p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
ScheduleExpression?: string;
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>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 <code>StartDate</code> you specify.
|
|
815
814
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
StartDate?: Date;
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>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 <code>EndDate</code> you specify.
|
|
821
820
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
EndDate?: Date;
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>The description of the schedule.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
Description?: string;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
ScheduleExpressionTimezone?: string;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
State?: ScheduleState;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The time at which the schedule was created.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
CreationDate?: Date;
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>The time at which the schedule was last modified.</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
LastModificationDate?: Date;
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
KmsKeyArn?: string;
|
|
854
854
|
/**
|
|
855
|
-
* @public
|
|
856
855
|
* <p>The schedule target.</p>
|
|
856
|
+
* @public
|
|
857
857
|
*/
|
|
858
858
|
Target?: Target;
|
|
859
859
|
/**
|
|
860
|
-
* @public
|
|
861
860
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
FlexibleTimeWindow?: FlexibleTimeWindow;
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
866
|
+
* @public
|
|
867
867
|
*/
|
|
868
868
|
ActionAfterCompletion?: ActionAfterCompletion;
|
|
869
869
|
}
|
|
@@ -872,80 +872,80 @@ export interface GetScheduleOutput {
|
|
|
872
872
|
*/
|
|
873
873
|
export interface ListSchedulesInput {
|
|
874
874
|
/**
|
|
875
|
-
* @public
|
|
876
875
|
* <p>If specified, only lists the schedules whose associated schedule group matches the given filter.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
GroupName?: string;
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <p>Schedule name prefix to return the filtered list of resources.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
NamePrefix?: string;
|
|
884
884
|
/**
|
|
885
|
-
* @public
|
|
886
885
|
* <p>If specified, only lists the schedules whose current state matches the given filter.</p>
|
|
886
|
+
* @public
|
|
887
887
|
*/
|
|
888
888
|
State?: ScheduleState;
|
|
889
889
|
/**
|
|
890
|
-
* @public
|
|
891
890
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
NextToken?: string;
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
896
|
+
* @public
|
|
897
897
|
*/
|
|
898
898
|
MaxResults?: number;
|
|
899
899
|
}
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The details of a target.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
export interface TargetSummary {
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
907
|
+
* @public
|
|
908
908
|
*/
|
|
909
909
|
Arn: string | undefined;
|
|
910
910
|
}
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>The details of a schedule.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
export interface ScheduleSummary {
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
Arn?: string;
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>The name of the schedule.</p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
Name?: string;
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>The name of the schedule group associated with this schedule.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
GroupName?: string;
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
State?: ScheduleState;
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>The time at which the schedule was created.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
CreationDate?: Date;
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>The time at which the schedule was last modified.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
LastModificationDate?: Date;
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>The schedule's target details.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
Target?: TargetSummary;
|
|
951
951
|
}
|
|
@@ -954,13 +954,13 @@ export interface ScheduleSummary {
|
|
|
954
954
|
*/
|
|
955
955
|
export interface ListSchedulesOutput {
|
|
956
956
|
/**
|
|
957
|
-
* @public
|
|
958
957
|
* <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
NextToken?: string;
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The schedules that match the specified criteria.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
Schedules: ScheduleSummary[] | undefined;
|
|
966
966
|
}
|
|
@@ -969,18 +969,17 @@ export interface ListSchedulesOutput {
|
|
|
969
969
|
*/
|
|
970
970
|
export interface UpdateScheduleInput {
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The name of the schedule that you are updating.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
Name: string | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>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.
|
|
979
978
|
* If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
GroupName?: string;
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>
|
|
985
984
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
986
985
|
* </p>
|
|
@@ -1017,61 +1016,62 @@ export interface UpdateScheduleInput {
|
|
|
1017
1016
|
* <p>
|
|
1018
1017
|
* For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>.
|
|
1019
1018
|
* </p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
ScheduleExpression: string | undefined;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>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 <code>StartDate</code> you specify.
|
|
1025
1024
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
1025
|
+
* @public
|
|
1026
1026
|
*/
|
|
1027
1027
|
StartDate?: Date;
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>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 <code>EndDate</code> you specify.
|
|
1031
1030
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
1031
|
+
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
EndDate?: Date;
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>The description you specify for the schedule.</p>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
Description?: string;
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
1041
|
+
* @public
|
|
1042
1042
|
*/
|
|
1043
1043
|
ScheduleExpressionTimezone?: string;
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
State?: ScheduleState;
|
|
1049
1049
|
/**
|
|
1050
|
-
* @public
|
|
1051
1050
|
* <p>The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.</p>
|
|
1051
|
+
* @public
|
|
1052
1052
|
*/
|
|
1053
1053
|
KmsKeyArn?: string;
|
|
1054
1054
|
/**
|
|
1055
|
-
* @public
|
|
1056
1055
|
* <p>The schedule target. You can use this operation to change the target that your schedule invokes.</p>
|
|
1056
|
+
* @public
|
|
1057
1057
|
*/
|
|
1058
1058
|
Target: Target | undefined;
|
|
1059
1059
|
/**
|
|
1060
|
-
* @public
|
|
1061
1060
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
1061
|
+
* @public
|
|
1062
1062
|
*/
|
|
1063
1063
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
1064
1064
|
/**
|
|
1065
|
-
* @public
|
|
1066
1065
|
* <p>
|
|
1067
1066
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
1068
1067
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
1069
1068
|
* </p>
|
|
1069
|
+
* @public
|
|
1070
1070
|
*/
|
|
1071
1071
|
ClientToken?: string;
|
|
1072
1072
|
/**
|
|
1073
|
-
* @public
|
|
1074
1073
|
* <p>Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
1074
|
+
* @public
|
|
1075
1075
|
*/
|
|
1076
1076
|
ActionAfterCompletion?: ActionAfterCompletion;
|
|
1077
1077
|
}
|
|
@@ -1080,8 +1080,8 @@ export interface UpdateScheduleInput {
|
|
|
1080
1080
|
*/
|
|
1081
1081
|
export interface UpdateScheduleOutput {
|
|
1082
1082
|
/**
|
|
1083
|
-
* @public
|
|
1084
1083
|
* <p>The Amazon Resource Name (ARN) of the schedule that you updated.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
ScheduleArn: string | undefined;
|
|
1087
1087
|
}
|
|
@@ -1090,21 +1090,21 @@ export interface UpdateScheduleOutput {
|
|
|
1090
1090
|
*/
|
|
1091
1091
|
export interface CreateScheduleGroupInput {
|
|
1092
1092
|
/**
|
|
1093
|
-
* @public
|
|
1094
1093
|
* <p>The name of the schedule group that you are creating.</p>
|
|
1094
|
+
* @public
|
|
1095
1095
|
*/
|
|
1096
1096
|
Name: string | undefined;
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>The list of tags to associate with the schedule group.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
Tags?: Tag[];
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>
|
|
1105
1104
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
1106
1105
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
1107
1106
|
* </p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
ClientToken?: string;
|
|
1110
1110
|
}
|
|
@@ -1113,8 +1113,8 @@ export interface CreateScheduleGroupInput {
|
|
|
1113
1113
|
*/
|
|
1114
1114
|
export interface CreateScheduleGroupOutput {
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
1117
|
+
* @public
|
|
1118
1118
|
*/
|
|
1119
1119
|
ScheduleGroupArn: string | undefined;
|
|
1120
1120
|
}
|
|
@@ -1123,16 +1123,16 @@ export interface CreateScheduleGroupOutput {
|
|
|
1123
1123
|
*/
|
|
1124
1124
|
export interface DeleteScheduleGroupInput {
|
|
1125
1125
|
/**
|
|
1126
|
-
* @public
|
|
1127
1126
|
* <p>The name of the schedule group to delete.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
Name: string | undefined;
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>
|
|
1133
1132
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
1134
1133
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
1135
1134
|
* </p>
|
|
1135
|
+
* @public
|
|
1136
1136
|
*/
|
|
1137
1137
|
ClientToken?: string;
|
|
1138
1138
|
}
|
|
@@ -1146,8 +1146,8 @@ export interface DeleteScheduleGroupOutput {
|
|
|
1146
1146
|
*/
|
|
1147
1147
|
export interface GetScheduleGroupInput {
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The name of the schedule group to retrieve.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
Name: string | undefined;
|
|
1153
1153
|
}
|
|
@@ -1168,28 +1168,28 @@ export type ScheduleGroupState = (typeof ScheduleGroupState)[keyof typeof Schedu
|
|
|
1168
1168
|
*/
|
|
1169
1169
|
export interface GetScheduleGroupOutput {
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
Arn?: string;
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The name of the schedule group.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
Name?: string;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>Specifies the state of the schedule group.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
State?: ScheduleGroupState;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The time at which the schedule group was created.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
CreationDate?: Date;
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>The time at which the schedule group was last modified.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
LastModificationDate?: Date;
|
|
1195
1195
|
}
|
|
@@ -1198,49 +1198,49 @@ export interface GetScheduleGroupOutput {
|
|
|
1198
1198
|
*/
|
|
1199
1199
|
export interface ListScheduleGroupsInput {
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The name prefix that you can use to return a filtered list of your schedule groups.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
NamePrefix?: string;
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
NextToken?: string;
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
MaxResults?: number;
|
|
1215
1215
|
}
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>The details of a schedule group.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
export interface ScheduleGroupSummary {
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
Arn?: string;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <p>The name of the schedule group.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
Name?: string;
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>Specifies the state of the schedule group.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
State?: ScheduleGroupState;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The time at which the schedule group was created.</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
CreationDate?: Date;
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>The time at which the schedule group was last modified.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
LastModificationDate?: Date;
|
|
1246
1246
|
}
|
|
@@ -1249,13 +1249,13 @@ export interface ScheduleGroupSummary {
|
|
|
1249
1249
|
*/
|
|
1250
1250
|
export interface ListScheduleGroupsOutput {
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
NextToken?: string;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The schedule groups that match the specified criteria.</p>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
ScheduleGroups: ScheduleGroupSummary[] | undefined;
|
|
1261
1261
|
}
|
|
@@ -1264,13 +1264,13 @@ export interface ListScheduleGroupsOutput {
|
|
|
1264
1264
|
*/
|
|
1265
1265
|
export interface TagResourceInput {
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
ResourceArn: string | undefined;
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>The list of tags to associate with the schedule group.</p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
Tags: Tag[] | undefined;
|
|
1276
1276
|
}
|
|
@@ -1284,13 +1284,13 @@ export interface TagResourceOutput {
|
|
|
1284
1284
|
*/
|
|
1285
1285
|
export interface UntagResourceInput {
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
ResourceArn: string | undefined;
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
TagKeys: string[] | undefined;
|
|
1296
1296
|
}
|