@aws-sdk/client-scheduler 3.379.1 → 3.382.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-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +5 -1
- package/dist-cjs/protocols/Aws_restJson1.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/commands/CreateScheduleCommand.d.ts +1 -0
- package/dist-types/commands/GetScheduleCommand.d.ts +1 -0
- package/dist-types/commands/UpdateScheduleCommand.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +167 -3
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +9 -0
- package/package.json +5 -5
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const q = "
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://scheduler.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ScheduleGroupState = exports.ServiceQuotaExceededException = exports.PropagateTags = exports.PlacementStrategyType = exports.PlacementConstraintType = exports.LaunchType = exports.ScheduleState = exports.FlexibleTimeWindowMode = exports.ConflictException = exports.ValidationException = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.AssignPublicIp = void 0;
|
|
3
|
+
exports.ScheduleGroupState = exports.ServiceQuotaExceededException = exports.PropagateTags = exports.PlacementStrategyType = exports.PlacementConstraintType = exports.LaunchType = exports.ScheduleState = exports.FlexibleTimeWindowMode = exports.ConflictException = exports.ValidationException = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.AssignPublicIp = exports.ActionAfterCompletion = void 0;
|
|
4
4
|
const SchedulerServiceException_1 = require("./SchedulerServiceException");
|
|
5
|
+
exports.ActionAfterCompletion = {
|
|
6
|
+
DELETE: "DELETE",
|
|
7
|
+
NONE: "NONE",
|
|
8
|
+
};
|
|
5
9
|
exports.AssignPublicIp = {
|
|
6
10
|
DISABLED: "DISABLED",
|
|
7
11
|
ENABLED: "ENABLED",
|
|
@@ -15,6 +15,7 @@ const se_CreateScheduleCommand = async (input, context) => {
|
|
|
15
15
|
resolvedPath = (0, smithy_client_1.resolvedPath)(resolvedPath, input, "Name", () => input.Name, "{Name}", false);
|
|
16
16
|
let body;
|
|
17
17
|
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
18
|
+
ActionAfterCompletion: [],
|
|
18
19
|
ClientToken: [true, (_) => _ ?? (0, uuid_1.v4)()],
|
|
19
20
|
Description: [],
|
|
20
21
|
EndDate: (_) => Math.round(_.getTime() / 1000),
|
|
@@ -260,6 +261,7 @@ const se_UpdateScheduleCommand = async (input, context) => {
|
|
|
260
261
|
resolvedPath = (0, smithy_client_1.resolvedPath)(resolvedPath, input, "Name", () => input.Name, "{Name}", false);
|
|
261
262
|
let body;
|
|
262
263
|
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
264
|
+
ActionAfterCompletion: [],
|
|
263
265
|
ClientToken: [true, (_) => _ ?? (0, uuid_1.v4)()],
|
|
264
266
|
Description: [],
|
|
265
267
|
EndDate: (_) => Math.round(_.getTime() / 1000),
|
|
@@ -471,6 +473,7 @@ const de_GetScheduleCommand = async (output, context) => {
|
|
|
471
473
|
});
|
|
472
474
|
const data = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.expectObject)(await parseBody(output.body, context)), "body");
|
|
473
475
|
const doc = (0, smithy_client_1.take)(data, {
|
|
476
|
+
ActionAfterCompletion: smithy_client_1.expectString,
|
|
474
477
|
Arn: smithy_client_1.expectString,
|
|
475
478
|
CreationDate: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
476
479
|
Description: smithy_client_1.expectString,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const q = "
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://scheduler.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://scheduler.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -12,6 +12,7 @@ export const se_CreateScheduleCommand = async (input, context) => {
|
|
|
12
12
|
resolvedPath = __resolvedPath(resolvedPath, input, "Name", () => input.Name, "{Name}", false);
|
|
13
13
|
let body;
|
|
14
14
|
body = JSON.stringify(take(input, {
|
|
15
|
+
ActionAfterCompletion: [],
|
|
15
16
|
ClientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
16
17
|
Description: [],
|
|
17
18
|
EndDate: (_) => Math.round(_.getTime() / 1000),
|
|
@@ -246,6 +247,7 @@ export const se_UpdateScheduleCommand = async (input, context) => {
|
|
|
246
247
|
resolvedPath = __resolvedPath(resolvedPath, input, "Name", () => input.Name, "{Name}", false);
|
|
247
248
|
let body;
|
|
248
249
|
body = JSON.stringify(take(input, {
|
|
250
|
+
ActionAfterCompletion: [],
|
|
249
251
|
ClientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
250
252
|
Description: [],
|
|
251
253
|
EndDate: (_) => Math.round(_.getTime() / 1000),
|
|
@@ -452,6 +454,7 @@ export const de_GetScheduleCommand = async (output, context) => {
|
|
|
452
454
|
});
|
|
453
455
|
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
454
456
|
const doc = take(data, {
|
|
457
|
+
ActionAfterCompletion: __expectString,
|
|
455
458
|
Arn: __expectString,
|
|
456
459
|
CreationDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
457
460
|
Description: __expectString,
|
|
@@ -121,6 +121,7 @@ export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __Met
|
|
|
121
121
|
* MaximumWindowInMinutes: Number("int"),
|
|
122
122
|
* },
|
|
123
123
|
* ClientToken: "STRING_VALUE",
|
|
124
|
+
* ActionAfterCompletion: "STRING_VALUE",
|
|
124
125
|
* };
|
|
125
126
|
* const command = new CreateScheduleCommand(input);
|
|
126
127
|
* const response = await client.send(command);
|
|
@@ -129,6 +129,7 @@ export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataB
|
|
|
129
129
|
* // Mode: "STRING_VALUE", // required
|
|
130
130
|
* // MaximumWindowInMinutes: Number("int"),
|
|
131
131
|
* // },
|
|
132
|
+
* // ActionAfterCompletion: "STRING_VALUE",
|
|
132
133
|
* // };
|
|
133
134
|
*
|
|
134
135
|
* ```
|
|
@@ -129,6 +129,7 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
|
|
|
129
129
|
* MaximumWindowInMinutes: Number("int"),
|
|
130
130
|
* },
|
|
131
131
|
* ClientToken: "STRING_VALUE",
|
|
132
|
+
* ActionAfterCompletion: "STRING_VALUE",
|
|
132
133
|
* };
|
|
133
134
|
* const command = new UpdateScheduleCommand(input);
|
|
134
135
|
* const response = await client.send(command);
|
|
@@ -15,7 +15,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
15
15
|
defaultSigningName: string;
|
|
16
16
|
};
|
|
17
17
|
export interface EndpointParameters extends __EndpointParameters {
|
|
18
|
-
Region
|
|
18
|
+
Region?: string;
|
|
19
19
|
UseDualStack?: boolean;
|
|
20
20
|
UseFIPS?: boolean;
|
|
21
21
|
Endpoint?: string;
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SchedulerServiceException as __BaseException } from "./SchedulerServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* @enum
|
|
6
|
+
*/
|
|
7
|
+
export declare const ActionAfterCompletion: {
|
|
8
|
+
readonly DELETE: "DELETE";
|
|
9
|
+
readonly NONE: "NONE";
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type ActionAfterCompletion = (typeof ActionAfterCompletion)[keyof typeof ActionAfterCompletion];
|
|
3
15
|
/**
|
|
4
16
|
* @public
|
|
5
17
|
* @enum
|
|
@@ -30,6 +42,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
30
42
|
*/
|
|
31
43
|
export interface ListTagsForResourceInput {
|
|
32
44
|
/**
|
|
45
|
+
* @public
|
|
33
46
|
* <p>The ARN of the EventBridge Scheduler resource for which you want to view tags.</p>
|
|
34
47
|
*/
|
|
35
48
|
ResourceArn: string | undefined;
|
|
@@ -40,10 +53,12 @@ export interface ListTagsForResourceInput {
|
|
|
40
53
|
*/
|
|
41
54
|
export interface Tag {
|
|
42
55
|
/**
|
|
56
|
+
* @public
|
|
43
57
|
* <p>The key for the tag.</p>
|
|
44
58
|
*/
|
|
45
59
|
Key: string | undefined;
|
|
46
60
|
/**
|
|
61
|
+
* @public
|
|
47
62
|
* <p>The value for the tag.</p>
|
|
48
63
|
*/
|
|
49
64
|
Value: string | undefined;
|
|
@@ -53,6 +68,7 @@ export interface Tag {
|
|
|
53
68
|
*/
|
|
54
69
|
export interface ListTagsForResourceOutput {
|
|
55
70
|
/**
|
|
71
|
+
* @public
|
|
56
72
|
* <p>The list of tags associated with the specified resource.</p>
|
|
57
73
|
*/
|
|
58
74
|
Tags?: Tag[];
|
|
@@ -127,10 +143,12 @@ export type FlexibleTimeWindowMode = (typeof FlexibleTimeWindowMode)[keyof typeo
|
|
|
127
143
|
*/
|
|
128
144
|
export interface FlexibleTimeWindow {
|
|
129
145
|
/**
|
|
146
|
+
* @public
|
|
130
147
|
* <p>Determines whether the schedule is invoked within a flexible time window.</p>
|
|
131
148
|
*/
|
|
132
149
|
Mode: FlexibleTimeWindowMode | string | undefined;
|
|
133
150
|
/**
|
|
151
|
+
* @public
|
|
134
152
|
* <p>The maximum time window during which a schedule can be invoked.</p>
|
|
135
153
|
*/
|
|
136
154
|
MaximumWindowInMinutes?: number;
|
|
@@ -153,6 +171,7 @@ export type ScheduleState = (typeof ScheduleState)[keyof typeof ScheduleState];
|
|
|
153
171
|
*/
|
|
154
172
|
export interface DeadLetterConfig {
|
|
155
173
|
/**
|
|
174
|
+
* @public
|
|
156
175
|
* <p>The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.</p>
|
|
157
176
|
*/
|
|
158
177
|
Arn?: string;
|
|
@@ -163,15 +182,18 @@ export interface DeadLetterConfig {
|
|
|
163
182
|
*/
|
|
164
183
|
export interface CapacityProviderStrategyItem {
|
|
165
184
|
/**
|
|
185
|
+
* @public
|
|
166
186
|
* <p>The short name of the capacity provider.</p>
|
|
167
187
|
*/
|
|
168
188
|
capacityProvider: string | undefined;
|
|
169
189
|
/**
|
|
190
|
+
* @public
|
|
170
191
|
* <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
|
|
171
192
|
* base value, if defined, is satisfied.</p>
|
|
172
193
|
*/
|
|
173
194
|
weight?: number;
|
|
174
195
|
/**
|
|
196
|
+
* @public
|
|
175
197
|
* <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.
|
|
176
198
|
* If no value is specified, the default value of <code>0</code> is used.</p>
|
|
177
199
|
*/
|
|
@@ -196,15 +218,18 @@ export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
|
|
|
196
218
|
*/
|
|
197
219
|
export interface AwsVpcConfiguration {
|
|
198
220
|
/**
|
|
221
|
+
* @public
|
|
199
222
|
* <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>
|
|
200
223
|
*/
|
|
201
224
|
Subnets: string[] | undefined;
|
|
202
225
|
/**
|
|
226
|
+
* @public
|
|
203
227
|
* <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.
|
|
204
228
|
* If you do not specify a security group, the default security group for the VPC is used.</p>
|
|
205
229
|
*/
|
|
206
230
|
SecurityGroups?: string[];
|
|
207
231
|
/**
|
|
232
|
+
* @public
|
|
208
233
|
* <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>
|
|
209
234
|
*/
|
|
210
235
|
AssignPublicIp?: AssignPublicIp | string;
|
|
@@ -215,6 +240,7 @@ export interface AwsVpcConfiguration {
|
|
|
215
240
|
*/
|
|
216
241
|
export interface NetworkConfiguration {
|
|
217
242
|
/**
|
|
243
|
+
* @public
|
|
218
244
|
* <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>
|
|
219
245
|
*/
|
|
220
246
|
awsvpcConfiguration?: AwsVpcConfiguration;
|
|
@@ -237,10 +263,12 @@ export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typ
|
|
|
237
263
|
*/
|
|
238
264
|
export interface PlacementConstraint {
|
|
239
265
|
/**
|
|
266
|
+
* @public
|
|
240
267
|
* <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>
|
|
241
268
|
*/
|
|
242
269
|
type?: PlacementConstraintType | string;
|
|
243
270
|
/**
|
|
271
|
+
* @public
|
|
244
272
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is <code>distinctInstance</code>.
|
|
245
273
|
* 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>
|
|
246
274
|
*/
|
|
@@ -265,12 +293,14 @@ export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof
|
|
|
265
293
|
*/
|
|
266
294
|
export interface PlacementStrategy {
|
|
267
295
|
/**
|
|
296
|
+
* @public
|
|
268
297
|
* <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
|
|
269
298
|
* 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.
|
|
270
299
|
* 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>
|
|
271
300
|
*/
|
|
272
301
|
type?: PlacementStrategyType | string;
|
|
273
302
|
/**
|
|
303
|
+
* @public
|
|
274
304
|
* <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),
|
|
275
305
|
* 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
|
|
276
306
|
* <code>cpu</code> and <code>memory</code>. For the random placement strategy, this field is not used.</p>
|
|
@@ -296,53 +326,65 @@ export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
|
|
|
296
326
|
*/
|
|
297
327
|
export interface EcsParameters {
|
|
298
328
|
/**
|
|
329
|
+
* @public
|
|
299
330
|
* <p>The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.</p>
|
|
300
331
|
*/
|
|
301
332
|
TaskDefinitionArn: string | undefined;
|
|
302
333
|
/**
|
|
334
|
+
* @public
|
|
303
335
|
* <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>.</p>
|
|
304
336
|
*/
|
|
305
337
|
TaskCount?: number;
|
|
306
338
|
/**
|
|
339
|
+
* @public
|
|
307
340
|
* <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.
|
|
308
341
|
* The <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS is supported.
|
|
309
342
|
* 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>
|
|
310
343
|
*/
|
|
311
344
|
LaunchType?: LaunchType | string;
|
|
312
345
|
/**
|
|
346
|
+
* @public
|
|
313
347
|
* <p>This structure specifies the network configuration for an ECS task.</p>
|
|
314
348
|
*/
|
|
315
349
|
NetworkConfiguration?: NetworkConfiguration;
|
|
316
350
|
/**
|
|
351
|
+
* @public
|
|
317
352
|
* <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>
|
|
318
353
|
*/
|
|
319
354
|
PlatformVersion?: string;
|
|
320
355
|
/**
|
|
356
|
+
* @public
|
|
321
357
|
* <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
|
|
322
358
|
*/
|
|
323
359
|
Group?: string;
|
|
324
360
|
/**
|
|
361
|
+
* @public
|
|
325
362
|
* <p>The capacity provider strategy to use for the task.</p>
|
|
326
363
|
*/
|
|
327
364
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
328
365
|
/**
|
|
366
|
+
* @public
|
|
329
367
|
* <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>
|
|
330
368
|
* in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
331
369
|
*/
|
|
332
370
|
EnableECSManagedTags?: boolean;
|
|
333
371
|
/**
|
|
372
|
+
* @public
|
|
334
373
|
* <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>
|
|
335
374
|
*/
|
|
336
375
|
EnableExecuteCommand?: boolean;
|
|
337
376
|
/**
|
|
377
|
+
* @public
|
|
338
378
|
* <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>
|
|
339
379
|
*/
|
|
340
380
|
PlacementConstraints?: PlacementConstraint[];
|
|
341
381
|
/**
|
|
382
|
+
* @public
|
|
342
383
|
* <p>The task placement strategy for a task or service.</p>
|
|
343
384
|
*/
|
|
344
385
|
PlacementStrategy?: PlacementStrategy[];
|
|
345
386
|
/**
|
|
387
|
+
* @public
|
|
346
388
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated.
|
|
347
389
|
* 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">
|
|
348
390
|
* <code>TagResource</code>
|
|
@@ -352,10 +394,12 @@ export interface EcsParameters {
|
|
|
352
394
|
*/
|
|
353
395
|
PropagateTags?: PropagateTags | string;
|
|
354
396
|
/**
|
|
397
|
+
* @public
|
|
355
398
|
* <p>The reference ID to use for the task.</p>
|
|
356
399
|
*/
|
|
357
400
|
ReferenceId?: string;
|
|
358
401
|
/**
|
|
402
|
+
* @public
|
|
359
403
|
* <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.
|
|
360
404
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
|
|
361
405
|
* <code>RunTask</code>
|
|
@@ -371,10 +415,12 @@ export interface EcsParameters {
|
|
|
371
415
|
*/
|
|
372
416
|
export interface EventBridgeParameters {
|
|
373
417
|
/**
|
|
418
|
+
* @public
|
|
374
419
|
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
375
420
|
*/
|
|
376
421
|
DetailType: string | undefined;
|
|
377
422
|
/**
|
|
423
|
+
* @public
|
|
378
424
|
* <p>The source of the event.</p>
|
|
379
425
|
*/
|
|
380
426
|
Source: string | undefined;
|
|
@@ -387,6 +433,7 @@ export interface EventBridgeParameters {
|
|
|
387
433
|
*/
|
|
388
434
|
export interface KinesisParameters {
|
|
389
435
|
/**
|
|
436
|
+
* @public
|
|
390
437
|
* <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
|
|
391
438
|
* <i>Amazon Kinesis Streams Developer Guide</i>.</p>
|
|
392
439
|
*/
|
|
@@ -398,10 +445,12 @@ export interface KinesisParameters {
|
|
|
398
445
|
*/
|
|
399
446
|
export interface RetryPolicy {
|
|
400
447
|
/**
|
|
448
|
+
* @public
|
|
401
449
|
* <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
|
|
402
450
|
*/
|
|
403
451
|
MaximumEventAgeInSeconds?: number;
|
|
404
452
|
/**
|
|
453
|
+
* @public
|
|
405
454
|
* <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
|
|
406
455
|
* until the duration of the <code>MaximumEventAgeInSeconds</code> is reached.</p>
|
|
407
456
|
*/
|
|
@@ -413,10 +462,12 @@ export interface RetryPolicy {
|
|
|
413
462
|
*/
|
|
414
463
|
export interface SageMakerPipelineParameter {
|
|
415
464
|
/**
|
|
465
|
+
* @public
|
|
416
466
|
* <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
417
467
|
*/
|
|
418
468
|
Name: string | undefined;
|
|
419
469
|
/**
|
|
470
|
+
* @public
|
|
420
471
|
* <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
421
472
|
*/
|
|
422
473
|
Value: string | undefined;
|
|
@@ -429,6 +480,7 @@ export interface SageMakerPipelineParameter {
|
|
|
429
480
|
*/
|
|
430
481
|
export interface SageMakerPipelineParameters {
|
|
431
482
|
/**
|
|
483
|
+
* @public
|
|
432
484
|
* <p>List of parameter names and values to use when executing the SageMaker Model Building Pipeline.</p>
|
|
433
485
|
*/
|
|
434
486
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
@@ -445,6 +497,7 @@ export interface SageMakerPipelineParameters {
|
|
|
445
497
|
*/
|
|
446
498
|
export interface SqsParameters {
|
|
447
499
|
/**
|
|
500
|
+
* @public
|
|
448
501
|
* <p>The FIFO message group ID to use as the target.</p>
|
|
449
502
|
*/
|
|
450
503
|
MessageGroupId?: string;
|
|
@@ -456,52 +509,62 @@ export interface SqsParameters {
|
|
|
456
509
|
*/
|
|
457
510
|
export interface Target {
|
|
458
511
|
/**
|
|
512
|
+
* @public
|
|
459
513
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
460
514
|
*/
|
|
461
515
|
Arn: string | undefined;
|
|
462
516
|
/**
|
|
517
|
+
* @public
|
|
463
518
|
* <p>The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.</p>
|
|
464
519
|
*/
|
|
465
520
|
RoleArn: string | undefined;
|
|
466
521
|
/**
|
|
522
|
+
* @public
|
|
467
523
|
* <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>
|
|
468
524
|
*/
|
|
469
525
|
DeadLetterConfig?: DeadLetterConfig;
|
|
470
526
|
/**
|
|
527
|
+
* @public
|
|
471
528
|
* <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>
|
|
472
529
|
*/
|
|
473
530
|
RetryPolicy?: RetryPolicy;
|
|
474
531
|
/**
|
|
532
|
+
* @public
|
|
475
533
|
* <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,
|
|
476
534
|
* 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
|
|
477
535
|
* delivers a default notification to the target.</p>
|
|
478
536
|
*/
|
|
479
537
|
Input?: string;
|
|
480
538
|
/**
|
|
539
|
+
* @public
|
|
481
540
|
* <p>The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
|
|
482
541
|
* <code>RunTask</code>
|
|
483
542
|
* </a> API operation.</p>
|
|
484
543
|
*/
|
|
485
544
|
EcsParameters?: EcsParameters;
|
|
486
545
|
/**
|
|
546
|
+
* @public
|
|
487
547
|
* <p>The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">
|
|
488
548
|
* <code>PutEvents</code>
|
|
489
549
|
* </a> API operation.</p>
|
|
490
550
|
*/
|
|
491
551
|
EventBridgeParameters?: EventBridgeParameters;
|
|
492
552
|
/**
|
|
553
|
+
* @public
|
|
493
554
|
* <p>The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html">
|
|
494
555
|
* <code>PutRecord</code>
|
|
495
556
|
* </a> API operation.</p>
|
|
496
557
|
*/
|
|
497
558
|
KinesisParameters?: KinesisParameters;
|
|
498
559
|
/**
|
|
560
|
+
* @public
|
|
499
561
|
* <p>The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html">
|
|
500
562
|
* <code>StartPipelineExecution</code>
|
|
501
563
|
* </a> API operation.</p>
|
|
502
564
|
*/
|
|
503
565
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
504
566
|
/**
|
|
567
|
+
* @public
|
|
505
568
|
* <p>The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html">
|
|
506
569
|
* <code>SendMessage</code>
|
|
507
570
|
* </a> API operation.
|
|
@@ -516,14 +579,17 @@ export interface Target {
|
|
|
516
579
|
*/
|
|
517
580
|
export interface CreateScheduleInput {
|
|
518
581
|
/**
|
|
582
|
+
* @public
|
|
519
583
|
* <p>The name of the schedule that you are creating.</p>
|
|
520
584
|
*/
|
|
521
585
|
Name: string | undefined;
|
|
522
586
|
/**
|
|
587
|
+
* @public
|
|
523
588
|
* <p>The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.</p>
|
|
524
589
|
*/
|
|
525
590
|
GroupName?: string;
|
|
526
591
|
/**
|
|
592
|
+
* @public
|
|
527
593
|
* <p>
|
|
528
594
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
529
595
|
* </p>
|
|
@@ -535,7 +601,7 @@ export interface CreateScheduleInput {
|
|
|
535
601
|
* </li>
|
|
536
602
|
* <li>
|
|
537
603
|
* <p>
|
|
538
|
-
* <code>rate</code> expression - <code>rate(unit
|
|
604
|
+
* <code>rate</code> expression - <code>rate(value unit)</code>
|
|
539
605
|
* </p>
|
|
540
606
|
* </li>
|
|
541
607
|
* <li>
|
|
@@ -563,52 +629,67 @@ export interface CreateScheduleInput {
|
|
|
563
629
|
*/
|
|
564
630
|
ScheduleExpression: string | undefined;
|
|
565
631
|
/**
|
|
632
|
+
* @public
|
|
566
633
|
* <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.
|
|
567
634
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
568
635
|
*/
|
|
569
636
|
StartDate?: Date;
|
|
570
637
|
/**
|
|
638
|
+
* @public
|
|
571
639
|
* <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.
|
|
572
640
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
573
641
|
*/
|
|
574
642
|
EndDate?: Date;
|
|
575
643
|
/**
|
|
644
|
+
* @public
|
|
576
645
|
* <p>The description you specify for the schedule.</p>
|
|
577
646
|
*/
|
|
578
647
|
Description?: string;
|
|
579
648
|
/**
|
|
649
|
+
* @public
|
|
580
650
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
581
651
|
*/
|
|
582
652
|
ScheduleExpressionTimezone?: string;
|
|
583
653
|
/**
|
|
654
|
+
* @public
|
|
584
655
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
585
656
|
*/
|
|
586
657
|
State?: ScheduleState | string;
|
|
587
658
|
/**
|
|
659
|
+
* @public
|
|
588
660
|
* <p>The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.</p>
|
|
589
661
|
*/
|
|
590
662
|
KmsKeyArn?: string;
|
|
591
663
|
/**
|
|
664
|
+
* @public
|
|
592
665
|
* <p>The schedule's target.</p>
|
|
593
666
|
*/
|
|
594
667
|
Target: Target | undefined;
|
|
595
668
|
/**
|
|
669
|
+
* @public
|
|
596
670
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
597
671
|
*/
|
|
598
672
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
599
673
|
/**
|
|
674
|
+
* @public
|
|
600
675
|
* <p>
|
|
601
676
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
602
677
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
603
678
|
* </p>
|
|
604
679
|
*/
|
|
605
680
|
ClientToken?: string;
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
* <p>Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
684
|
+
*/
|
|
685
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
606
686
|
}
|
|
607
687
|
/**
|
|
608
688
|
* @public
|
|
609
689
|
*/
|
|
610
690
|
export interface CreateScheduleOutput {
|
|
611
691
|
/**
|
|
692
|
+
* @public
|
|
612
693
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
613
694
|
*/
|
|
614
695
|
ScheduleArn: string | undefined;
|
|
@@ -631,14 +712,17 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
631
712
|
*/
|
|
632
713
|
export interface DeleteScheduleInput {
|
|
633
714
|
/**
|
|
715
|
+
* @public
|
|
634
716
|
* <p>The name of the schedule to delete.</p>
|
|
635
717
|
*/
|
|
636
718
|
Name: string | undefined;
|
|
637
719
|
/**
|
|
720
|
+
* @public
|
|
638
721
|
* <p>The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.</p>
|
|
639
722
|
*/
|
|
640
723
|
GroupName?: string;
|
|
641
724
|
/**
|
|
725
|
+
* @public
|
|
642
726
|
* <p>
|
|
643
727
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
644
728
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
@@ -656,10 +740,12 @@ export interface DeleteScheduleOutput {
|
|
|
656
740
|
*/
|
|
657
741
|
export interface GetScheduleInput {
|
|
658
742
|
/**
|
|
743
|
+
* @public
|
|
659
744
|
* <p>The name of the schedule to retrieve.</p>
|
|
660
745
|
*/
|
|
661
746
|
Name: string | undefined;
|
|
662
747
|
/**
|
|
748
|
+
* @public
|
|
663
749
|
* <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>
|
|
664
750
|
*/
|
|
665
751
|
GroupName?: string;
|
|
@@ -669,18 +755,22 @@ export interface GetScheduleInput {
|
|
|
669
755
|
*/
|
|
670
756
|
export interface GetScheduleOutput {
|
|
671
757
|
/**
|
|
758
|
+
* @public
|
|
672
759
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
673
760
|
*/
|
|
674
761
|
Arn?: string;
|
|
675
762
|
/**
|
|
763
|
+
* @public
|
|
676
764
|
* <p>The name of the schedule group associated with this schedule.</p>
|
|
677
765
|
*/
|
|
678
766
|
GroupName?: string;
|
|
679
767
|
/**
|
|
768
|
+
* @public
|
|
680
769
|
* <p>The name of the schedule.</p>
|
|
681
770
|
*/
|
|
682
771
|
Name?: string;
|
|
683
772
|
/**
|
|
773
|
+
* @public
|
|
684
774
|
* <p>
|
|
685
775
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
686
776
|
* </p>
|
|
@@ -692,7 +782,7 @@ export interface GetScheduleOutput {
|
|
|
692
782
|
* </li>
|
|
693
783
|
* <li>
|
|
694
784
|
* <p>
|
|
695
|
-
* <code>rate</code> expression - <code>rate(unit
|
|
785
|
+
* <code>rate</code> expression - <code>rate(value unit)</code>
|
|
696
786
|
* </p>
|
|
697
787
|
* </li>
|
|
698
788
|
* <li>
|
|
@@ -720,69 +810,89 @@ export interface GetScheduleOutput {
|
|
|
720
810
|
*/
|
|
721
811
|
ScheduleExpression?: string;
|
|
722
812
|
/**
|
|
813
|
+
* @public
|
|
723
814
|
* <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.
|
|
724
815
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
725
816
|
*/
|
|
726
817
|
StartDate?: Date;
|
|
727
818
|
/**
|
|
819
|
+
* @public
|
|
728
820
|
* <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.
|
|
729
821
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
730
822
|
*/
|
|
731
823
|
EndDate?: Date;
|
|
732
824
|
/**
|
|
825
|
+
* @public
|
|
733
826
|
* <p>The description of the schedule.</p>
|
|
734
827
|
*/
|
|
735
828
|
Description?: string;
|
|
736
829
|
/**
|
|
830
|
+
* @public
|
|
737
831
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
738
832
|
*/
|
|
739
833
|
ScheduleExpressionTimezone?: string;
|
|
740
834
|
/**
|
|
835
|
+
* @public
|
|
741
836
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
742
837
|
*/
|
|
743
838
|
State?: ScheduleState | string;
|
|
744
839
|
/**
|
|
840
|
+
* @public
|
|
745
841
|
* <p>The time at which the schedule was created.</p>
|
|
746
842
|
*/
|
|
747
843
|
CreationDate?: Date;
|
|
748
844
|
/**
|
|
845
|
+
* @public
|
|
749
846
|
* <p>The time at which the schedule was last modified.</p>
|
|
750
847
|
*/
|
|
751
848
|
LastModificationDate?: Date;
|
|
752
849
|
/**
|
|
850
|
+
* @public
|
|
753
851
|
* <p>The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.</p>
|
|
754
852
|
*/
|
|
755
853
|
KmsKeyArn?: string;
|
|
756
854
|
/**
|
|
855
|
+
* @public
|
|
757
856
|
* <p>The schedule target.</p>
|
|
758
857
|
*/
|
|
759
858
|
Target?: Target;
|
|
760
859
|
/**
|
|
860
|
+
* @public
|
|
761
861
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
762
862
|
*/
|
|
763
863
|
FlexibleTimeWindow?: FlexibleTimeWindow;
|
|
864
|
+
/**
|
|
865
|
+
* @public
|
|
866
|
+
* <p>Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
867
|
+
*/
|
|
868
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
764
869
|
}
|
|
765
870
|
/**
|
|
766
871
|
* @public
|
|
767
872
|
*/
|
|
768
873
|
export interface ListSchedulesInput {
|
|
769
874
|
/**
|
|
875
|
+
* @public
|
|
770
876
|
* <p>If specified, only lists the schedules whose associated schedule group matches the given filter.</p>
|
|
771
877
|
*/
|
|
772
878
|
GroupName?: string;
|
|
773
879
|
/**
|
|
880
|
+
* @public
|
|
774
881
|
* <p>Schedule name prefix to return the filtered list of resources.</p>
|
|
775
882
|
*/
|
|
776
883
|
NamePrefix?: string;
|
|
777
884
|
/**
|
|
885
|
+
* @public
|
|
778
886
|
* <p>If specified, only lists the schedules whose current state matches the given filter.</p>
|
|
779
887
|
*/
|
|
780
888
|
State?: ScheduleState | string;
|
|
781
889
|
/**
|
|
890
|
+
* @public
|
|
782
891
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
783
892
|
*/
|
|
784
893
|
NextToken?: string;
|
|
785
894
|
/**
|
|
895
|
+
* @public
|
|
786
896
|
* <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>
|
|
787
897
|
*/
|
|
788
898
|
MaxResults?: number;
|
|
@@ -793,6 +903,7 @@ export interface ListSchedulesInput {
|
|
|
793
903
|
*/
|
|
794
904
|
export interface TargetSummary {
|
|
795
905
|
/**
|
|
906
|
+
* @public
|
|
796
907
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
797
908
|
*/
|
|
798
909
|
Arn: string | undefined;
|
|
@@ -803,30 +914,37 @@ export interface TargetSummary {
|
|
|
803
914
|
*/
|
|
804
915
|
export interface ScheduleSummary {
|
|
805
916
|
/**
|
|
917
|
+
* @public
|
|
806
918
|
* <p>The Amazon Resource Name (ARN) of the schedule.</p>
|
|
807
919
|
*/
|
|
808
920
|
Arn?: string;
|
|
809
921
|
/**
|
|
922
|
+
* @public
|
|
810
923
|
* <p>The name of the schedule.</p>
|
|
811
924
|
*/
|
|
812
925
|
Name?: string;
|
|
813
926
|
/**
|
|
927
|
+
* @public
|
|
814
928
|
* <p>The name of the schedule group associated with this schedule.</p>
|
|
815
929
|
*/
|
|
816
930
|
GroupName?: string;
|
|
817
931
|
/**
|
|
932
|
+
* @public
|
|
818
933
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
819
934
|
*/
|
|
820
935
|
State?: ScheduleState | string;
|
|
821
936
|
/**
|
|
937
|
+
* @public
|
|
822
938
|
* <p>The time at which the schedule was created.</p>
|
|
823
939
|
*/
|
|
824
940
|
CreationDate?: Date;
|
|
825
941
|
/**
|
|
942
|
+
* @public
|
|
826
943
|
* <p>The time at which the schedule was last modified.</p>
|
|
827
944
|
*/
|
|
828
945
|
LastModificationDate?: Date;
|
|
829
946
|
/**
|
|
947
|
+
* @public
|
|
830
948
|
* <p>The schedule's target details.</p>
|
|
831
949
|
*/
|
|
832
950
|
Target?: TargetSummary;
|
|
@@ -836,10 +954,12 @@ export interface ScheduleSummary {
|
|
|
836
954
|
*/
|
|
837
955
|
export interface ListSchedulesOutput {
|
|
838
956
|
/**
|
|
957
|
+
* @public
|
|
839
958
|
* <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
|
|
840
959
|
*/
|
|
841
960
|
NextToken?: string;
|
|
842
961
|
/**
|
|
962
|
+
* @public
|
|
843
963
|
* <p>The schedules that match the specified criteria.</p>
|
|
844
964
|
*/
|
|
845
965
|
Schedules: ScheduleSummary[] | undefined;
|
|
@@ -849,15 +969,18 @@ export interface ListSchedulesOutput {
|
|
|
849
969
|
*/
|
|
850
970
|
export interface UpdateScheduleInput {
|
|
851
971
|
/**
|
|
972
|
+
* @public
|
|
852
973
|
* <p>The name of the schedule that you are updating.</p>
|
|
853
974
|
*/
|
|
854
975
|
Name: string | undefined;
|
|
855
976
|
/**
|
|
977
|
+
* @public
|
|
856
978
|
* <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.
|
|
857
979
|
* If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.</p>
|
|
858
980
|
*/
|
|
859
981
|
GroupName?: string;
|
|
860
982
|
/**
|
|
983
|
+
* @public
|
|
861
984
|
* <p>
|
|
862
985
|
* The expression that defines when the schedule runs. The following formats are supported.
|
|
863
986
|
* </p>
|
|
@@ -869,7 +992,7 @@ export interface UpdateScheduleInput {
|
|
|
869
992
|
* </li>
|
|
870
993
|
* <li>
|
|
871
994
|
* <p>
|
|
872
|
-
* <code>rate</code> expression - <code>rate(unit
|
|
995
|
+
* <code>rate</code> expression - <code>rate(value unit)</code>
|
|
873
996
|
* </p>
|
|
874
997
|
* </li>
|
|
875
998
|
* <li>
|
|
@@ -897,52 +1020,67 @@ export interface UpdateScheduleInput {
|
|
|
897
1020
|
*/
|
|
898
1021
|
ScheduleExpression: string | undefined;
|
|
899
1022
|
/**
|
|
1023
|
+
* @public
|
|
900
1024
|
* <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.
|
|
901
1025
|
* EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
|
|
902
1026
|
*/
|
|
903
1027
|
StartDate?: Date;
|
|
904
1028
|
/**
|
|
1029
|
+
* @public
|
|
905
1030
|
* <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.
|
|
906
1031
|
* EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
|
|
907
1032
|
*/
|
|
908
1033
|
EndDate?: Date;
|
|
909
1034
|
/**
|
|
1035
|
+
* @public
|
|
910
1036
|
* <p>The description you specify for the schedule.</p>
|
|
911
1037
|
*/
|
|
912
1038
|
Description?: string;
|
|
913
1039
|
/**
|
|
1040
|
+
* @public
|
|
914
1041
|
* <p>The timezone in which the scheduling expression is evaluated.</p>
|
|
915
1042
|
*/
|
|
916
1043
|
ScheduleExpressionTimezone?: string;
|
|
917
1044
|
/**
|
|
1045
|
+
* @public
|
|
918
1046
|
* <p>Specifies whether the schedule is enabled or disabled.</p>
|
|
919
1047
|
*/
|
|
920
1048
|
State?: ScheduleState | string;
|
|
921
1049
|
/**
|
|
1050
|
+
* @public
|
|
922
1051
|
* <p>The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.</p>
|
|
923
1052
|
*/
|
|
924
1053
|
KmsKeyArn?: string;
|
|
925
1054
|
/**
|
|
1055
|
+
* @public
|
|
926
1056
|
* <p>The schedule target. You can use this operation to change the target that your schedule invokes.</p>
|
|
927
1057
|
*/
|
|
928
1058
|
Target: Target | undefined;
|
|
929
1059
|
/**
|
|
1060
|
+
* @public
|
|
930
1061
|
* <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
|
|
931
1062
|
*/
|
|
932
1063
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
933
1064
|
/**
|
|
1065
|
+
* @public
|
|
934
1066
|
* <p>
|
|
935
1067
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
936
1068
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
937
1069
|
* </p>
|
|
938
1070
|
*/
|
|
939
1071
|
ClientToken?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* @public
|
|
1074
|
+
* <p>Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>
|
|
1075
|
+
*/
|
|
1076
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
940
1077
|
}
|
|
941
1078
|
/**
|
|
942
1079
|
* @public
|
|
943
1080
|
*/
|
|
944
1081
|
export interface UpdateScheduleOutput {
|
|
945
1082
|
/**
|
|
1083
|
+
* @public
|
|
946
1084
|
* <p>The Amazon Resource Name (ARN) of the schedule that you updated.</p>
|
|
947
1085
|
*/
|
|
948
1086
|
ScheduleArn: string | undefined;
|
|
@@ -952,14 +1090,17 @@ export interface UpdateScheduleOutput {
|
|
|
952
1090
|
*/
|
|
953
1091
|
export interface CreateScheduleGroupInput {
|
|
954
1092
|
/**
|
|
1093
|
+
* @public
|
|
955
1094
|
* <p>The name of the schedule group that you are creating.</p>
|
|
956
1095
|
*/
|
|
957
1096
|
Name: string | undefined;
|
|
958
1097
|
/**
|
|
1098
|
+
* @public
|
|
959
1099
|
* <p>The list of tags to associate with the schedule group.</p>
|
|
960
1100
|
*/
|
|
961
1101
|
Tags?: Tag[];
|
|
962
1102
|
/**
|
|
1103
|
+
* @public
|
|
963
1104
|
* <p>
|
|
964
1105
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
965
1106
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
@@ -972,6 +1113,7 @@ export interface CreateScheduleGroupInput {
|
|
|
972
1113
|
*/
|
|
973
1114
|
export interface CreateScheduleGroupOutput {
|
|
974
1115
|
/**
|
|
1116
|
+
* @public
|
|
975
1117
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
976
1118
|
*/
|
|
977
1119
|
ScheduleGroupArn: string | undefined;
|
|
@@ -981,10 +1123,12 @@ export interface CreateScheduleGroupOutput {
|
|
|
981
1123
|
*/
|
|
982
1124
|
export interface DeleteScheduleGroupInput {
|
|
983
1125
|
/**
|
|
1126
|
+
* @public
|
|
984
1127
|
* <p>The name of the schedule group to delete.</p>
|
|
985
1128
|
*/
|
|
986
1129
|
Name: string | undefined;
|
|
987
1130
|
/**
|
|
1131
|
+
* @public
|
|
988
1132
|
* <p>
|
|
989
1133
|
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,
|
|
990
1134
|
* EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
|
|
@@ -1002,6 +1146,7 @@ export interface DeleteScheduleGroupOutput {
|
|
|
1002
1146
|
*/
|
|
1003
1147
|
export interface GetScheduleGroupInput {
|
|
1004
1148
|
/**
|
|
1149
|
+
* @public
|
|
1005
1150
|
* <p>The name of the schedule group to retrieve.</p>
|
|
1006
1151
|
*/
|
|
1007
1152
|
Name: string | undefined;
|
|
@@ -1023,22 +1168,27 @@ export type ScheduleGroupState = (typeof ScheduleGroupState)[keyof typeof Schedu
|
|
|
1023
1168
|
*/
|
|
1024
1169
|
export interface GetScheduleGroupOutput {
|
|
1025
1170
|
/**
|
|
1171
|
+
* @public
|
|
1026
1172
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
1027
1173
|
*/
|
|
1028
1174
|
Arn?: string;
|
|
1029
1175
|
/**
|
|
1176
|
+
* @public
|
|
1030
1177
|
* <p>The name of the schedule group.</p>
|
|
1031
1178
|
*/
|
|
1032
1179
|
Name?: string;
|
|
1033
1180
|
/**
|
|
1181
|
+
* @public
|
|
1034
1182
|
* <p>Specifies the state of the schedule group.</p>
|
|
1035
1183
|
*/
|
|
1036
1184
|
State?: ScheduleGroupState | string;
|
|
1037
1185
|
/**
|
|
1186
|
+
* @public
|
|
1038
1187
|
* <p>The time at which the schedule group was created.</p>
|
|
1039
1188
|
*/
|
|
1040
1189
|
CreationDate?: Date;
|
|
1041
1190
|
/**
|
|
1191
|
+
* @public
|
|
1042
1192
|
* <p>The time at which the schedule group was last modified.</p>
|
|
1043
1193
|
*/
|
|
1044
1194
|
LastModificationDate?: Date;
|
|
@@ -1048,14 +1198,17 @@ export interface GetScheduleGroupOutput {
|
|
|
1048
1198
|
*/
|
|
1049
1199
|
export interface ListScheduleGroupsInput {
|
|
1050
1200
|
/**
|
|
1201
|
+
* @public
|
|
1051
1202
|
* <p>The name prefix that you can use to return a filtered list of your schedule groups.</p>
|
|
1052
1203
|
*/
|
|
1053
1204
|
NamePrefix?: string;
|
|
1054
1205
|
/**
|
|
1206
|
+
* @public
|
|
1055
1207
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1056
1208
|
*/
|
|
1057
1209
|
NextToken?: string;
|
|
1058
1210
|
/**
|
|
1211
|
+
* @public
|
|
1059
1212
|
* <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>
|
|
1060
1213
|
*/
|
|
1061
1214
|
MaxResults?: number;
|
|
@@ -1066,22 +1219,27 @@ export interface ListScheduleGroupsInput {
|
|
|
1066
1219
|
*/
|
|
1067
1220
|
export interface ScheduleGroupSummary {
|
|
1068
1221
|
/**
|
|
1222
|
+
* @public
|
|
1069
1223
|
* <p>The Amazon Resource Name (ARN) of the schedule group.</p>
|
|
1070
1224
|
*/
|
|
1071
1225
|
Arn?: string;
|
|
1072
1226
|
/**
|
|
1227
|
+
* @public
|
|
1073
1228
|
* <p>The name of the schedule group.</p>
|
|
1074
1229
|
*/
|
|
1075
1230
|
Name?: string;
|
|
1076
1231
|
/**
|
|
1232
|
+
* @public
|
|
1077
1233
|
* <p>Specifies the state of the schedule group.</p>
|
|
1078
1234
|
*/
|
|
1079
1235
|
State?: ScheduleGroupState | string;
|
|
1080
1236
|
/**
|
|
1237
|
+
* @public
|
|
1081
1238
|
* <p>The time at which the schedule group was created.</p>
|
|
1082
1239
|
*/
|
|
1083
1240
|
CreationDate?: Date;
|
|
1084
1241
|
/**
|
|
1242
|
+
* @public
|
|
1085
1243
|
* <p>The time at which the schedule group was last modified.</p>
|
|
1086
1244
|
*/
|
|
1087
1245
|
LastModificationDate?: Date;
|
|
@@ -1091,10 +1249,12 @@ export interface ScheduleGroupSummary {
|
|
|
1091
1249
|
*/
|
|
1092
1250
|
export interface ListScheduleGroupsOutput {
|
|
1093
1251
|
/**
|
|
1252
|
+
* @public
|
|
1094
1253
|
* <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
|
|
1095
1254
|
*/
|
|
1096
1255
|
NextToken?: string;
|
|
1097
1256
|
/**
|
|
1257
|
+
* @public
|
|
1098
1258
|
* <p>The schedule groups that match the specified criteria.</p>
|
|
1099
1259
|
*/
|
|
1100
1260
|
ScheduleGroups: ScheduleGroupSummary[] | undefined;
|
|
@@ -1104,10 +1264,12 @@ export interface ListScheduleGroupsOutput {
|
|
|
1104
1264
|
*/
|
|
1105
1265
|
export interface TagResourceInput {
|
|
1106
1266
|
/**
|
|
1267
|
+
* @public
|
|
1107
1268
|
* <p>The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.</p>
|
|
1108
1269
|
*/
|
|
1109
1270
|
ResourceArn: string | undefined;
|
|
1110
1271
|
/**
|
|
1272
|
+
* @public
|
|
1111
1273
|
* <p>The list of tags to associate with the schedule group.</p>
|
|
1112
1274
|
*/
|
|
1113
1275
|
Tags: Tag[] | undefined;
|
|
@@ -1122,10 +1284,12 @@ export interface TagResourceOutput {
|
|
|
1122
1284
|
*/
|
|
1123
1285
|
export interface UntagResourceInput {
|
|
1124
1286
|
/**
|
|
1287
|
+
* @public
|
|
1125
1288
|
* <p>The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.</p>
|
|
1126
1289
|
*/
|
|
1127
1290
|
ResourceArn: string | undefined;
|
|
1128
1291
|
/**
|
|
1292
|
+
* @public
|
|
1129
1293
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
1130
1294
|
*/
|
|
1131
1295
|
TagKeys: string[] | undefined;
|
|
@@ -26,7 +26,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
26
26
|
defaultSigningName: string;
|
|
27
27
|
};
|
|
28
28
|
export interface EndpointParameters extends __EndpointParameters {
|
|
29
|
-
Region
|
|
29
|
+
Region?: string;
|
|
30
30
|
UseDualStack?: boolean;
|
|
31
31
|
UseFIPS?: boolean;
|
|
32
32
|
Endpoint?: string;
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SchedulerServiceException as __BaseException } from "./SchedulerServiceException";
|
|
3
|
+
export declare const ActionAfterCompletion: {
|
|
4
|
+
readonly DELETE: "DELETE";
|
|
5
|
+
readonly NONE: "NONE";
|
|
6
|
+
};
|
|
7
|
+
export type ActionAfterCompletion =
|
|
8
|
+
(typeof ActionAfterCompletion)[keyof typeof ActionAfterCompletion];
|
|
3
9
|
export declare const AssignPublicIp: {
|
|
4
10
|
readonly DISABLED: "DISABLED";
|
|
5
11
|
readonly ENABLED: "ENABLED";
|
|
@@ -178,6 +184,7 @@ export interface CreateScheduleInput {
|
|
|
178
184
|
Target: Target | undefined;
|
|
179
185
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
180
186
|
ClientToken?: string;
|
|
187
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
181
188
|
}
|
|
182
189
|
export interface CreateScheduleOutput {
|
|
183
190
|
ScheduleArn: string | undefined;
|
|
@@ -215,6 +222,7 @@ export interface GetScheduleOutput {
|
|
|
215
222
|
KmsKeyArn?: string;
|
|
216
223
|
Target?: Target;
|
|
217
224
|
FlexibleTimeWindow?: FlexibleTimeWindow;
|
|
225
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
218
226
|
}
|
|
219
227
|
export interface ListSchedulesInput {
|
|
220
228
|
GroupName?: string;
|
|
@@ -252,6 +260,7 @@ export interface UpdateScheduleInput {
|
|
|
252
260
|
Target: Target | undefined;
|
|
253
261
|
FlexibleTimeWindow: FlexibleTimeWindow | undefined;
|
|
254
262
|
ClientToken?: string;
|
|
263
|
+
ActionAfterCompletion?: ActionAfterCompletion | string;
|
|
255
264
|
}
|
|
256
265
|
export interface UpdateScheduleOutput {
|
|
257
266
|
ScheduleArn: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-scheduler",
|
|
3
3
|
"description": "AWS SDK for JavaScript Scheduler Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|