@aws-sdk/client-scheduler 3.325.0 → 3.327.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.
Files changed (13) hide show
  1. package/dist-types/commands/CreateScheduleCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateScheduleGroupCommand.d.ts +6 -0
  3. package/dist-types/commands/DeleteScheduleCommand.d.ts +4 -0
  4. package/dist-types/commands/DeleteScheduleGroupCommand.d.ts +4 -0
  5. package/dist-types/commands/GetScheduleCommand.d.ts +97 -0
  6. package/dist-types/commands/GetScheduleGroupCommand.d.ts +10 -0
  7. package/dist-types/commands/ListScheduleGroupsCommand.d.ts +15 -0
  8. package/dist-types/commands/ListSchedulesCommand.d.ts +19 -0
  9. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  10. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  11. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  12. package/dist-types/commands/UpdateScheduleCommand.d.ts +6 -0
  13. package/package.json +7 -7
package/dist-types/commands/CreateScheduleCommand.d.ts CHANGED
@@ -120,6 +120,10 @@ export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __Met
120
120
  * };
121
121
  * const command = new CreateScheduleCommand(input);
122
122
  * const response = await client.send(command);
123
+ * // { // CreateScheduleOutput
124
+ * // ScheduleArn: "STRING_VALUE", // required
125
+ * // };
126
+ *
123
127
  * ```
124
128
  *
125
129
  * @param CreateScheduleCommandInput - {@link CreateScheduleCommandInput}
@@ -146,6 +150,8 @@ export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __Met
146
150
  * @throws {@link ValidationException} (client fault)
147
151
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
148
152
  *
153
+ * @throws {@link SchedulerServiceException}
154
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
149
155
  *
150
156
  */
151
157
  export declare class CreateScheduleCommand extends $Command<CreateScheduleCommandInput, CreateScheduleCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/CreateScheduleGroupCommand.d.ts CHANGED
@@ -38,6 +38,10 @@ export interface CreateScheduleGroupCommandOutput extends CreateScheduleGroupOut
38
38
  * };
39
39
  * const command = new CreateScheduleGroupCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateScheduleGroupOutput
42
+ * // ScheduleGroupArn: "STRING_VALUE", // required
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param CreateScheduleGroupCommandInput - {@link CreateScheduleGroupCommandInput}
@@ -61,6 +65,8 @@ export interface CreateScheduleGroupCommandOutput extends CreateScheduleGroupOut
61
65
  * @throws {@link ValidationException} (client fault)
62
66
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
63
67
  *
68
+ * @throws {@link SchedulerServiceException}
69
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
64
70
  *
65
71
  */
66
72
  export declare class CreateScheduleGroupCommand extends $Command<CreateScheduleGroupCommandInput, CreateScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/DeleteScheduleCommand.d.ts CHANGED
@@ -33,6 +33,8 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleOutput, __Met
33
33
  * };
34
34
  * const command = new DeleteScheduleCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteScheduleCommandInput - {@link DeleteScheduleCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleOutput, __Met
56
58
  * @throws {@link ValidationException} (client fault)
57
59
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
58
60
  *
61
+ * @throws {@link SchedulerServiceException}
62
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DeleteScheduleCommand extends $Command<DeleteScheduleCommandInput, DeleteScheduleCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/DeleteScheduleGroupCommand.d.ts CHANGED
@@ -40,6 +40,8 @@ export interface DeleteScheduleGroupCommandOutput extends DeleteScheduleGroupOut
40
40
  * };
41
41
  * const command = new DeleteScheduleGroupCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param DeleteScheduleGroupCommandInput - {@link DeleteScheduleGroupCommandInput}
@@ -63,6 +65,8 @@ export interface DeleteScheduleGroupCommandOutput extends DeleteScheduleGroupOut
63
65
  * @throws {@link ValidationException} (client fault)
64
66
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
65
67
  *
68
+ * @throws {@link SchedulerServiceException}
69
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
66
70
  *
67
71
  */
68
72
  export declare class DeleteScheduleGroupCommand extends $Command<DeleteScheduleGroupCommandInput, DeleteScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/GetScheduleCommand.d.ts CHANGED
@@ -32,6 +32,101 @@ export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataB
32
32
  * };
33
33
  * const command = new GetScheduleCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetScheduleOutput
36
+ * // Arn: "STRING_VALUE",
37
+ * // GroupName: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // ScheduleExpression: "STRING_VALUE",
40
+ * // StartDate: new Date("TIMESTAMP"),
41
+ * // EndDate: new Date("TIMESTAMP"),
42
+ * // Description: "STRING_VALUE",
43
+ * // ScheduleExpressionTimezone: "STRING_VALUE",
44
+ * // State: "STRING_VALUE",
45
+ * // CreationDate: new Date("TIMESTAMP"),
46
+ * // LastModificationDate: new Date("TIMESTAMP"),
47
+ * // KmsKeyArn: "STRING_VALUE",
48
+ * // Target: { // Target
49
+ * // Arn: "STRING_VALUE", // required
50
+ * // RoleArn: "STRING_VALUE", // required
51
+ * // DeadLetterConfig: { // DeadLetterConfig
52
+ * // Arn: "STRING_VALUE",
53
+ * // },
54
+ * // RetryPolicy: { // RetryPolicy
55
+ * // MaximumEventAgeInSeconds: Number("int"),
56
+ * // MaximumRetryAttempts: Number("int"),
57
+ * // },
58
+ * // Input: "STRING_VALUE",
59
+ * // EcsParameters: { // EcsParameters
60
+ * // TaskDefinitionArn: "STRING_VALUE", // required
61
+ * // TaskCount: Number("int"),
62
+ * // LaunchType: "STRING_VALUE",
63
+ * // NetworkConfiguration: { // NetworkConfiguration
64
+ * // awsvpcConfiguration: { // AwsVpcConfiguration
65
+ * // Subnets: [ // Subnets // required
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // SecurityGroups: [ // SecurityGroups
69
+ * // "STRING_VALUE",
70
+ * // ],
71
+ * // AssignPublicIp: "STRING_VALUE",
72
+ * // },
73
+ * // },
74
+ * // PlatformVersion: "STRING_VALUE",
75
+ * // Group: "STRING_VALUE",
76
+ * // CapacityProviderStrategy: [ // CapacityProviderStrategy
77
+ * // { // CapacityProviderStrategyItem
78
+ * // capacityProvider: "STRING_VALUE", // required
79
+ * // weight: Number("int"),
80
+ * // base: Number("int"),
81
+ * // },
82
+ * // ],
83
+ * // EnableECSManagedTags: true || false,
84
+ * // EnableExecuteCommand: true || false,
85
+ * // PlacementConstraints: [ // PlacementConstraints
86
+ * // { // PlacementConstraint
87
+ * // type: "STRING_VALUE",
88
+ * // expression: "STRING_VALUE",
89
+ * // },
90
+ * // ],
91
+ * // PlacementStrategy: [ // PlacementStrategies
92
+ * // { // PlacementStrategy
93
+ * // type: "STRING_VALUE",
94
+ * // field: "STRING_VALUE",
95
+ * // },
96
+ * // ],
97
+ * // PropagateTags: "STRING_VALUE",
98
+ * // ReferenceId: "STRING_VALUE",
99
+ * // Tags: [ // Tags
100
+ * // { // TagMap
101
+ * // "<keys>": "STRING_VALUE",
102
+ * // },
103
+ * // ],
104
+ * // },
105
+ * // EventBridgeParameters: { // EventBridgeParameters
106
+ * // DetailType: "STRING_VALUE", // required
107
+ * // Source: "STRING_VALUE", // required
108
+ * // },
109
+ * // KinesisParameters: { // KinesisParameters
110
+ * // PartitionKey: "STRING_VALUE", // required
111
+ * // },
112
+ * // SageMakerPipelineParameters: { // SageMakerPipelineParameters
113
+ * // PipelineParameterList: [ // SageMakerPipelineParameterList
114
+ * // { // SageMakerPipelineParameter
115
+ * // Name: "STRING_VALUE", // required
116
+ * // Value: "STRING_VALUE", // required
117
+ * // },
118
+ * // ],
119
+ * // },
120
+ * // SqsParameters: { // SqsParameters
121
+ * // MessageGroupId: "STRING_VALUE",
122
+ * // },
123
+ * // },
124
+ * // FlexibleTimeWindow: { // FlexibleTimeWindow
125
+ * // Mode: "STRING_VALUE", // required
126
+ * // MaximumWindowInMinutes: Number("int"),
127
+ * // },
128
+ * // };
129
+ *
35
130
  * ```
36
131
  *
37
132
  * @param GetScheduleCommandInput - {@link GetScheduleCommandInput}
@@ -52,6 +147,8 @@ export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataB
52
147
  * @throws {@link ValidationException} (client fault)
53
148
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
54
149
  *
150
+ * @throws {@link SchedulerServiceException}
151
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
55
152
  *
56
153
  */
57
154
  export declare class GetScheduleCommand extends $Command<GetScheduleCommandInput, GetScheduleCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/GetScheduleGroupCommand.d.ts CHANGED
@@ -31,6 +31,14 @@ export interface GetScheduleGroupCommandOutput extends GetScheduleGroupOutput, _
31
31
  * };
32
32
  * const command = new GetScheduleGroupCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetScheduleGroupOutput
35
+ * // Arn: "STRING_VALUE",
36
+ * // Name: "STRING_VALUE",
37
+ * // State: "STRING_VALUE",
38
+ * // CreationDate: new Date("TIMESTAMP"),
39
+ * // LastModificationDate: new Date("TIMESTAMP"),
40
+ * // };
41
+ *
34
42
  * ```
35
43
  *
36
44
  * @param GetScheduleGroupCommandInput - {@link GetScheduleGroupCommandInput}
@@ -51,6 +59,8 @@ export interface GetScheduleGroupCommandOutput extends GetScheduleGroupOutput, _
51
59
  * @throws {@link ValidationException} (client fault)
52
60
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
53
61
  *
62
+ * @throws {@link SchedulerServiceException}
63
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
54
64
  *
55
65
  */
56
66
  export declare class GetScheduleGroupCommand extends $Command<GetScheduleGroupCommandInput, GetScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/ListScheduleGroupsCommand.d.ts CHANGED
@@ -33,6 +33,19 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
33
33
  * };
34
34
  * const command = new ListScheduleGroupsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListScheduleGroupsOutput
37
+ * // NextToken: "STRING_VALUE",
38
+ * // ScheduleGroups: [ // ScheduleGroupList // required
39
+ * // { // ScheduleGroupSummary
40
+ * // Arn: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // State: "STRING_VALUE",
43
+ * // CreationDate: new Date("TIMESTAMP"),
44
+ * // LastModificationDate: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // ],
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListScheduleGroupsCommandInput - {@link ListScheduleGroupsCommandInput}
@@ -50,6 +63,8 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
50
63
  * @throws {@link ValidationException} (client fault)
51
64
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
52
65
  *
66
+ * @throws {@link SchedulerServiceException}
67
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
53
68
  *
54
69
  */
55
70
  export declare class ListScheduleGroupsCommand extends $Command<ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/ListSchedulesCommand.d.ts CHANGED
@@ -35,6 +35,23 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
35
35
  * };
36
36
  * const command = new ListSchedulesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListSchedulesOutput
39
+ * // NextToken: "STRING_VALUE",
40
+ * // Schedules: [ // ScheduleList // required
41
+ * // { // ScheduleSummary
42
+ * // Arn: "STRING_VALUE",
43
+ * // Name: "STRING_VALUE",
44
+ * // GroupName: "STRING_VALUE",
45
+ * // State: "STRING_VALUE",
46
+ * // CreationDate: new Date("TIMESTAMP"),
47
+ * // LastModificationDate: new Date("TIMESTAMP"),
48
+ * // Target: { // TargetSummary
49
+ * // Arn: "STRING_VALUE", // required
50
+ * // },
51
+ * // },
52
+ * // ],
53
+ * // };
54
+ *
38
55
  * ```
39
56
  *
40
57
  * @param ListSchedulesCommandInput - {@link ListSchedulesCommandInput}
@@ -55,6 +72,8 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
55
72
  * @throws {@link ValidationException} (client fault)
56
73
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
57
74
  *
75
+ * @throws {@link SchedulerServiceException}
76
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
58
77
  *
59
78
  */
60
79
  export declare class ListSchedulesCommand extends $Command<ListSchedulesCommandInput, ListSchedulesCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceOutput
35
+ * // Tags: [ // TagList
36
+ * // { // Tag
37
+ * // Key: "STRING_VALUE", // required
38
+ * // Value: "STRING_VALUE", // required
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -51,6 +60,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
51
60
  * @throws {@link ValidationException} (client fault)
52
61
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
53
62
  *
63
+ * @throws {@link SchedulerServiceException}
64
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
54
65
  *
55
66
  */
56
67
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -37,6 +37,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
37
37
  * };
38
38
  * const command = new TagResourceCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
60
62
  * @throws {@link ValidationException} (client fault)
61
63
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
62
64
  *
65
+ * @throws {@link SchedulerServiceException}
66
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
63
67
  *
64
68
  */
65
69
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -57,6 +59,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
57
59
  * @throws {@link ValidationException} (client fault)
58
60
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
59
61
  *
62
+ * @throws {@link SchedulerServiceException}
63
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SchedulerClientResolvedConfig> {
package/dist-types/commands/UpdateScheduleCommand.d.ts CHANGED
@@ -128,6 +128,10 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
128
128
  * };
129
129
  * const command = new UpdateScheduleCommand(input);
130
130
  * const response = await client.send(command);
131
+ * // { // UpdateScheduleOutput
132
+ * // ScheduleArn: "STRING_VALUE", // required
133
+ * // };
134
+ *
131
135
  * ```
132
136
  *
133
137
  * @param UpdateScheduleCommandInput - {@link UpdateScheduleCommandInput}
@@ -151,6 +155,8 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
151
155
  * @throws {@link ValidationException} (client fault)
152
156
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
153
157
  *
158
+ * @throws {@link SchedulerServiceException}
159
+ * <p>Base exception class for all service exceptions from Scheduler service.</p>
154
160
  *
155
161
  */
156
162
  export declare class UpdateScheduleCommand extends $Command<UpdateScheduleCommandInput, UpdateScheduleCommandOutput, SchedulerClientResolvedConfig> {
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.325.0",
4
+ "version": "3.327.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,9 +21,9 @@
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.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",