@aws-sdk/client-scheduler 3.296.0 → 3.297.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.
@@ -13,6 +13,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
13
13
  import { UpdateScheduleCommandInput, UpdateScheduleCommandOutput } from "./commands/UpdateScheduleCommand";
14
14
  import { SchedulerClient } from "./SchedulerClient";
15
15
  /**
16
+ * @public
16
17
  * <p>
17
18
  * Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service.
18
19
  * EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets.
@@ -21,24 +22,28 @@ import { SchedulerClient } from "./SchedulerClient";
21
22
  */
22
23
  export declare class Scheduler extends SchedulerClient {
23
24
  /**
25
+ * @public
24
26
  * <p>Creates the specified schedule.</p>
25
27
  */
26
28
  createSchedule(args: CreateScheduleCommandInput, options?: __HttpHandlerOptions): Promise<CreateScheduleCommandOutput>;
27
29
  createSchedule(args: CreateScheduleCommandInput, cb: (err: any, data?: CreateScheduleCommandOutput) => void): void;
28
30
  createSchedule(args: CreateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduleCommandOutput) => void): void;
29
31
  /**
32
+ * @public
30
33
  * <p>Creates the specified schedule group.</p>
31
34
  */
32
35
  createScheduleGroup(args: CreateScheduleGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateScheduleGroupCommandOutput>;
33
36
  createScheduleGroup(args: CreateScheduleGroupCommandInput, cb: (err: any, data?: CreateScheduleGroupCommandOutput) => void): void;
34
37
  createScheduleGroup(args: CreateScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduleGroupCommandOutput) => void): void;
35
38
  /**
39
+ * @public
36
40
  * <p>Deletes the specified schedule.</p>
37
41
  */
38
42
  deleteSchedule(args: DeleteScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScheduleCommandOutput>;
39
43
  deleteSchedule(args: DeleteScheduleCommandInput, cb: (err: any, data?: DeleteScheduleCommandOutput) => void): void;
40
44
  deleteSchedule(args: DeleteScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleCommandOutput) => void): void;
41
45
  /**
46
+ * @public
42
47
  * <p>Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group.
43
48
  * When you delete a group, it remains in a <code>DELETING</code> state until all of its associated schedules are deleted.
44
49
  * Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets
@@ -53,48 +58,56 @@ export declare class Scheduler extends SchedulerClient {
53
58
  deleteScheduleGroup(args: DeleteScheduleGroupCommandInput, cb: (err: any, data?: DeleteScheduleGroupCommandOutput) => void): void;
54
59
  deleteScheduleGroup(args: DeleteScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleGroupCommandOutput) => void): void;
55
60
  /**
61
+ * @public
56
62
  * <p>Retrieves the specified schedule.</p>
57
63
  */
58
64
  getSchedule(args: GetScheduleCommandInput, options?: __HttpHandlerOptions): Promise<GetScheduleCommandOutput>;
59
65
  getSchedule(args: GetScheduleCommandInput, cb: (err: any, data?: GetScheduleCommandOutput) => void): void;
60
66
  getSchedule(args: GetScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScheduleCommandOutput) => void): void;
61
67
  /**
68
+ * @public
62
69
  * <p>Retrieves the specified schedule group.</p>
63
70
  */
64
71
  getScheduleGroup(args: GetScheduleGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetScheduleGroupCommandOutput>;
65
72
  getScheduleGroup(args: GetScheduleGroupCommandInput, cb: (err: any, data?: GetScheduleGroupCommandOutput) => void): void;
66
73
  getScheduleGroup(args: GetScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScheduleGroupCommandOutput) => void): void;
67
74
  /**
75
+ * @public
68
76
  * <p>Returns a paginated list of your schedule groups.</p>
69
77
  */
70
78
  listScheduleGroups(args: ListScheduleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListScheduleGroupsCommandOutput>;
71
79
  listScheduleGroups(args: ListScheduleGroupsCommandInput, cb: (err: any, data?: ListScheduleGroupsCommandOutput) => void): void;
72
80
  listScheduleGroups(args: ListScheduleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduleGroupsCommandOutput) => void): void;
73
81
  /**
82
+ * @public
74
83
  * <p>Returns a paginated list of your EventBridge Scheduler schedules.</p>
75
84
  */
76
85
  listSchedules(args: ListSchedulesCommandInput, options?: __HttpHandlerOptions): Promise<ListSchedulesCommandOutput>;
77
86
  listSchedules(args: ListSchedulesCommandInput, cb: (err: any, data?: ListSchedulesCommandOutput) => void): void;
78
87
  listSchedules(args: ListSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchedulesCommandOutput) => void): void;
79
88
  /**
89
+ * @public
80
90
  * <p>Lists the tags associated with the Scheduler resource.</p>
81
91
  */
82
92
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
83
93
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
84
94
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
85
95
  /**
96
+ * @public
86
97
  * <p>Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.</p>
87
98
  */
88
99
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
89
100
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
90
101
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
91
102
  /**
103
+ * @public
92
104
  * <p>Removes one or more tags from the specified EventBridge Scheduler schedule group.</p>
93
105
  */
94
106
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
95
107
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
96
108
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
97
109
  /**
110
+ * @public
98
111
  * <p>
99
112
  * Updates the specified schedule. When you call <code>UpdateSchedule</code>, EventBridge Scheduler uses all values, including empty values, specified in the request and
100
113
  * overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to
@@ -20,15 +20,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
20
20
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
21
21
  import { UpdateScheduleCommandInput, UpdateScheduleCommandOutput } from "./commands/UpdateScheduleCommand";
22
22
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
23
+ /**
24
+ * @public
25
+ */
23
26
  export type ServiceInputTypes = CreateScheduleCommandInput | CreateScheduleGroupCommandInput | DeleteScheduleCommandInput | DeleteScheduleGroupCommandInput | GetScheduleCommandInput | GetScheduleGroupCommandInput | ListScheduleGroupsCommandInput | ListSchedulesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateScheduleCommandInput;
27
+ /**
28
+ * @public
29
+ */
24
30
  export type ServiceOutputTypes = CreateScheduleCommandOutput | CreateScheduleGroupCommandOutput | DeleteScheduleCommandOutput | DeleteScheduleGroupCommandOutput | GetScheduleCommandOutput | GetScheduleGroupCommandOutput | ListScheduleGroupsCommandOutput | ListSchedulesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateScheduleCommandOutput;
31
+ /**
32
+ * @public
33
+ */
25
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
26
35
  /**
27
36
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
28
37
  */
29
38
  requestHandler?: __HttpHandler;
30
39
  /**
31
- * A constructor for a class implementing the {@link __Checksum} interface
40
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
32
41
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
33
42
  * @internal
34
43
  */
@@ -118,23 +127,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
118
127
  */
119
128
  logger?: __Logger;
120
129
  /**
121
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
130
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
131
  */
123
132
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
124
133
  }
134
+ /**
135
+ * @public
136
+ */
125
137
  type SchedulerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
126
138
  /**
127
- * The configuration interface of SchedulerClient class constructor that set the region, credentials and other options.
139
+ * @public
140
+ *
141
+ * The configuration interface of SchedulerClient class constructor that set the region, credentials and other options.
128
142
  */
129
143
  export interface SchedulerClientConfig extends SchedulerClientConfigType {
130
144
  }
145
+ /**
146
+ * @public
147
+ */
131
148
  type SchedulerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
132
149
  /**
133
- * The resolved configuration interface of SchedulerClient class. This is resolved and normalized from the {@link SchedulerClientConfig | constructor configuration interface}.
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of SchedulerClient class. This is resolved and normalized from the {@link SchedulerClientConfig | constructor configuration interface}.
134
153
  */
135
154
  export interface SchedulerClientResolvedConfig extends SchedulerClientResolvedConfigType {
136
155
  }
137
156
  /**
157
+ * @public
138
158
  * <p>
139
159
  * Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service.
140
160
  * EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets.
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateScheduleInput, CreateScheduleOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateScheduleCommand}.
8
10
  */
9
11
  export interface CreateScheduleCommandInput extends CreateScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateScheduleCommand}.
13
17
  */
14
18
  export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates the specified schedule.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateScheduleCommandInput - {@link CreateScheduleCommandInput}
34
+ * @returns {@link CreateScheduleCommandOutput}
28
35
  * @see {@link CreateScheduleCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateScheduleCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateScheduleCommandOutput extends CreateScheduleOutput, __Met
52
59
  export declare class CreateScheduleCommand extends $Command<CreateScheduleCommandInput, CreateScheduleCommandOutput, SchedulerClientResolvedConfig> {
53
60
  readonly input: CreateScheduleCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateScheduleCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateScheduleCommandInput, CreateScheduleCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateScheduleGroupInput, CreateScheduleGroupOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateScheduleGroupCommand}.
8
10
  */
9
11
  export interface CreateScheduleGroupCommandInput extends CreateScheduleGroupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateScheduleGroupCommand}.
13
17
  */
14
18
  export interface CreateScheduleGroupCommandOutput extends CreateScheduleGroupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates the specified schedule group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateScheduleGroupCommandOutput extends CreateScheduleGroupOut
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateScheduleGroupCommandInput - {@link CreateScheduleGroupCommandInput}
34
+ * @returns {@link CreateScheduleGroupCommandOutput}
28
35
  * @see {@link CreateScheduleGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateScheduleGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateScheduleGroupCommandOutput extends CreateScheduleGroupOut
49
56
  export declare class CreateScheduleGroupCommand extends $Command<CreateScheduleGroupCommandInput, CreateScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
50
57
  readonly input: CreateScheduleGroupCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateScheduleGroupCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateScheduleGroupCommandInput, CreateScheduleGroupCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteScheduleInput, DeleteScheduleOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteScheduleCommand}.
8
10
  */
9
11
  export interface DeleteScheduleCommandInput extends DeleteScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteScheduleCommand}.
13
17
  */
14
18
  export interface DeleteScheduleCommandOutput extends DeleteScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified schedule.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteScheduleCommandInput - {@link DeleteScheduleCommandInput}
34
+ * @returns {@link DeleteScheduleCommandOutput}
28
35
  * @see {@link DeleteScheduleCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteScheduleCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleOutput, __Met
49
56
  export declare class DeleteScheduleCommand extends $Command<DeleteScheduleCommandInput, DeleteScheduleCommandOutput, SchedulerClientResolvedConfig> {
50
57
  readonly input: DeleteScheduleCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteScheduleCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteScheduleCommandInput, DeleteScheduleCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteScheduleGroupInput, DeleteScheduleGroupOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteScheduleGroupCommand}.
8
10
  */
9
11
  export interface DeleteScheduleGroupCommandInput extends DeleteScheduleGroupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteScheduleGroupCommand}.
13
17
  */
14
18
  export interface DeleteScheduleGroupCommandOutput extends DeleteScheduleGroupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group.
18
23
  * When you delete a group, it remains in a <code>DELETING</code> state until all of its associated schedules are deleted.
19
24
  * Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets
@@ -33,6 +38,8 @@ export interface DeleteScheduleGroupCommandOutput extends DeleteScheduleGroupOut
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DeleteScheduleGroupCommandInput - {@link DeleteScheduleGroupCommandInput}
42
+ * @returns {@link DeleteScheduleGroupCommandOutput}
36
43
  * @see {@link DeleteScheduleGroupCommandInput} for command's `input` shape.
37
44
  * @see {@link DeleteScheduleGroupCommandOutput} for command's `response` shape.
38
45
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DeleteScheduleGroupCommandOutput extends DeleteScheduleGroupOut
57
64
  export declare class DeleteScheduleGroupCommand extends $Command<DeleteScheduleGroupCommandInput, DeleteScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
58
65
  readonly input: DeleteScheduleGroupCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DeleteScheduleGroupCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteScheduleGroupCommandInput, DeleteScheduleGroupCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetScheduleInput, GetScheduleOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetScheduleCommand}.
8
10
  */
9
11
  export interface GetScheduleCommandInput extends GetScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetScheduleCommand}.
13
17
  */
14
18
  export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the specified schedule.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetScheduleCommandInput - {@link GetScheduleCommandInput}
34
+ * @returns {@link GetScheduleCommandOutput}
28
35
  * @see {@link GetScheduleCommandInput} for command's `input` shape.
29
36
  * @see {@link GetScheduleCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetScheduleCommandOutput extends GetScheduleOutput, __MetadataB
46
53
  export declare class GetScheduleCommand extends $Command<GetScheduleCommandInput, GetScheduleCommandOutput, SchedulerClientResolvedConfig> {
47
54
  readonly input: GetScheduleCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetScheduleCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetScheduleCommandInput, GetScheduleCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetScheduleGroupInput, GetScheduleGroupOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetScheduleGroupCommand}.
8
10
  */
9
11
  export interface GetScheduleGroupCommandInput extends GetScheduleGroupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetScheduleGroupCommand}.
13
17
  */
14
18
  export interface GetScheduleGroupCommandOutput extends GetScheduleGroupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the specified schedule group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetScheduleGroupCommandOutput extends GetScheduleGroupOutput, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetScheduleGroupCommandInput - {@link GetScheduleGroupCommandInput}
34
+ * @returns {@link GetScheduleGroupCommandOutput}
28
35
  * @see {@link GetScheduleGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link GetScheduleGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetScheduleGroupCommandOutput extends GetScheduleGroupOutput, _
46
53
  export declare class GetScheduleGroupCommand extends $Command<GetScheduleGroupCommandInput, GetScheduleGroupCommandOutput, SchedulerClientResolvedConfig> {
47
54
  readonly input: GetScheduleGroupCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetScheduleGroupCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetScheduleGroupCommandInput, GetScheduleGroupCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListScheduleGroupsInput, ListScheduleGroupsOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListScheduleGroupsCommand}.
8
10
  */
9
11
  export interface ListScheduleGroupsCommandInput extends ListScheduleGroupsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListScheduleGroupsCommand}.
13
17
  */
14
18
  export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a paginated list of your schedule groups.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListScheduleGroupsCommandInput - {@link ListScheduleGroupsCommandInput}
34
+ * @returns {@link ListScheduleGroupsCommandOutput}
28
35
  * @see {@link ListScheduleGroupsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListScheduleGroupsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
43
50
  export declare class ListScheduleGroupsCommand extends $Command<ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput, SchedulerClientResolvedConfig> {
44
51
  readonly input: ListScheduleGroupsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListScheduleGroupsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListSchedulesInput, ListSchedulesOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSchedulesCommand}.
8
10
  */
9
11
  export interface ListSchedulesCommandInput extends ListSchedulesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSchedulesCommand}.
13
17
  */
14
18
  export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a paginated list of your EventBridge Scheduler schedules.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListSchedulesCommandInput - {@link ListSchedulesCommandInput}
34
+ * @returns {@link ListSchedulesCommandOutput}
28
35
  * @see {@link ListSchedulesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListSchedulesCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
46
53
  export declare class ListSchedulesCommand extends $Command<ListSchedulesCommandInput, ListSchedulesCommandOutput, SchedulerClientResolvedConfig> {
47
54
  readonly input: ListSchedulesCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListSchedulesCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSchedulesCommandInput, ListSchedulesCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags associated with the Scheduler resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
46
53
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SchedulerClientResolvedConfig> {
47
54
  readonly input: ListTagsForResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTagsForResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceInput, TagResourceOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
49
56
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SchedulerClientResolvedConfig> {
50
57
  readonly input: TagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: TagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more tags from the specified EventBridge Scheduler schedule group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
49
56
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SchedulerClientResolvedConfig> {
50
57
  readonly input: UntagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UntagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateScheduleInput, UpdateScheduleOutput } from "../models/models_0";
5
5
  import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateScheduleCommand}.
8
10
  */
9
11
  export interface UpdateScheduleCommandInput extends UpdateScheduleInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateScheduleCommand}.
13
17
  */
14
18
  export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Updates the specified schedule. When you call <code>UpdateSchedule</code>, EventBridge Scheduler uses all values, including empty values, specified in the request and
19
24
  * overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to
@@ -33,6 +38,8 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param UpdateScheduleCommandInput - {@link UpdateScheduleCommandInput}
42
+ * @returns {@link UpdateScheduleCommandOutput}
36
43
  * @see {@link UpdateScheduleCommandInput} for command's `input` shape.
37
44
  * @see {@link UpdateScheduleCommandOutput} for command's `response` shape.
38
45
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
57
64
  export declare class UpdateScheduleCommand extends $Command<UpdateScheduleCommandInput, UpdateScheduleCommandOutput, SchedulerClientResolvedConfig> {
58
65
  readonly input: UpdateScheduleCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: UpdateScheduleCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScheduleCommandInput, UpdateScheduleCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Scheduler service.
4
6
  */
5
7
  export declare class SchedulerServiceException extends __ServiceException {
@@ -1,10 +1,14 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { SchedulerServiceException as __BaseException } from "./SchedulerServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum AssignPublicIp {
4
7
  DISABLED = "DISABLED",
5
8
  ENABLED = "ENABLED"
6
9
  }
7
10
  /**
11
+ * @public
8
12
  * <p>Unexpected error encountered while processing the request.</p>
9
13
  */
10
14
  export declare class InternalServerException extends __BaseException {
@@ -16,6 +20,9 @@ export declare class InternalServerException extends __BaseException {
16
20
  */
17
21
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
18
22
  }
23
+ /**
24
+ * @public
25
+ */
19
26
  export interface ListTagsForResourceInput {
20
27
  /**
21
28
  * <p>The ARN of the EventBridge Scheduler resource for which you want to view tags.</p>
@@ -23,6 +30,7 @@ export interface ListTagsForResourceInput {
23
30
  ResourceArn: string | undefined;
24
31
  }
25
32
  /**
33
+ * @public
26
34
  * <p>Tag to associate with a schedule group.</p>
27
35
  */
28
36
  export interface Tag {
@@ -35,6 +43,9 @@ export interface Tag {
35
43
  */
36
44
  Value: string | undefined;
37
45
  }
46
+ /**
47
+ * @public
48
+ */
38
49
  export interface ListTagsForResourceOutput {
39
50
  /**
40
51
  * <p>The list of tags associated with the specified resource.</p>
@@ -42,6 +53,7 @@ export interface ListTagsForResourceOutput {
42
53
  Tags?: Tag[];
43
54
  }
44
55
  /**
56
+ * @public
45
57
  * <p>The request references a resource which does not exist.</p>
46
58
  */
47
59
  export declare class ResourceNotFoundException extends __BaseException {
@@ -54,6 +66,7 @@ export declare class ResourceNotFoundException extends __BaseException {
54
66
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
55
67
  }
56
68
  /**
69
+ * @public
57
70
  * <p>The request was denied due to request throttling.</p>
58
71
  */
59
72
  export declare class ThrottlingException extends __BaseException {
@@ -66,6 +79,7 @@ export declare class ThrottlingException extends __BaseException {
66
79
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
67
80
  }
68
81
  /**
82
+ * @public
69
83
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
70
84
  */
71
85
  export declare class ValidationException extends __BaseException {
@@ -78,6 +92,7 @@ export declare class ValidationException extends __BaseException {
78
92
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
79
93
  }
80
94
  /**
95
+ * @public
81
96
  * <p>Updating or deleting the resource can cause an inconsistent state.</p>
82
97
  */
83
98
  export declare class ConflictException extends __BaseException {
@@ -89,11 +104,15 @@ export declare class ConflictException extends __BaseException {
89
104
  */
90
105
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
91
106
  }
107
+ /**
108
+ * @public
109
+ */
92
110
  export declare enum FlexibleTimeWindowMode {
93
111
  FLEXIBLE = "FLEXIBLE",
94
112
  OFF = "OFF"
95
113
  }
96
114
  /**
115
+ * @public
97
116
  * <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
98
117
  */
99
118
  export interface FlexibleTimeWindow {
@@ -106,11 +125,15 @@ export interface FlexibleTimeWindow {
106
125
  */
107
126
  MaximumWindowInMinutes?: number;
108
127
  }
128
+ /**
129
+ * @public
130
+ */
109
131
  export declare enum ScheduleState {
110
132
  DISABLED = "DISABLED",
111
133
  ENABLED = "ENABLED"
112
134
  }
113
135
  /**
136
+ * @public
114
137
  * <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>
115
138
  */
116
139
  export interface DeadLetterConfig {
@@ -120,6 +143,7 @@ export interface DeadLetterConfig {
120
143
  Arn?: string;
121
144
  }
122
145
  /**
146
+ * @public
123
147
  * <p>The details of a capacity provider strategy.</p>
124
148
  */
125
149
  export interface CapacityProviderStrategyItem {
@@ -138,12 +162,16 @@ export interface CapacityProviderStrategyItem {
138
162
  */
139
163
  base?: number;
140
164
  }
165
+ /**
166
+ * @public
167
+ */
141
168
  export declare enum LaunchType {
142
169
  EC2 = "EC2",
143
170
  EXTERNAL = "EXTERNAL",
144
171
  FARGATE = "FARGATE"
145
172
  }
146
173
  /**
174
+ * @public
147
175
  * <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>
148
176
  */
149
177
  export interface AwsVpcConfiguration {
@@ -162,6 +190,7 @@ export interface AwsVpcConfiguration {
162
190
  AssignPublicIp?: AssignPublicIp | string;
163
191
  }
164
192
  /**
193
+ * @public
165
194
  * <p>Specifies the network configuration for an ECS task.</p>
166
195
  */
167
196
  export interface NetworkConfiguration {
@@ -170,11 +199,15 @@ export interface NetworkConfiguration {
170
199
  */
171
200
  awsvpcConfiguration?: AwsVpcConfiguration;
172
201
  }
202
+ /**
203
+ * @public
204
+ */
173
205
  export declare enum PlacementConstraintType {
174
206
  DISTINCT_INSTANCE = "distinctInstance",
175
207
  MEMBER_OF = "memberOf"
176
208
  }
177
209
  /**
210
+ * @public
178
211
  * <p>An object representing a constraint on task placement.</p>
179
212
  */
180
213
  export interface PlacementConstraint {
@@ -188,12 +221,16 @@ export interface PlacementConstraint {
188
221
  */
189
222
  expression?: string;
190
223
  }
224
+ /**
225
+ * @public
226
+ */
191
227
  export declare enum PlacementStrategyType {
192
228
  BINPACK = "binpack",
193
229
  RANDOM = "random",
194
230
  SPREAD = "spread"
195
231
  }
196
232
  /**
233
+ * @public
197
234
  * <p>The task placement strategy for a task or service.</p>
198
235
  */
199
236
  export interface PlacementStrategy {
@@ -210,10 +247,14 @@ export interface PlacementStrategy {
210
247
  */
211
248
  field?: string;
212
249
  }
250
+ /**
251
+ * @public
252
+ */
213
253
  export declare enum PropagateTags {
214
254
  TASK_DEFINITION = "TASK_DEFINITION"
215
255
  }
216
256
  /**
257
+ * @public
217
258
  * <p>The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
218
259
  * <code>RunTask</code>
219
260
  * </a> API operation.</p>
@@ -288,6 +329,7 @@ export interface EcsParameters {
288
329
  Tags?: Record<string, string>[];
289
330
  }
290
331
  /**
332
+ * @public
291
333
  * <p>The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">
292
334
  * <code>PutEvents</code>
293
335
  * </a> API operation.</p>
@@ -303,6 +345,7 @@ export interface EventBridgeParameters {
303
345
  Source: string | undefined;
304
346
  }
305
347
  /**
348
+ * @public
306
349
  * <p>The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html">
307
350
  * <code>PutRecord</code>
308
351
  * </a> API operation.</p>
@@ -315,6 +358,7 @@ export interface KinesisParameters {
315
358
  PartitionKey: string | undefined;
316
359
  }
317
360
  /**
361
+ * @public
318
362
  * <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>
319
363
  */
320
364
  export interface RetryPolicy {
@@ -329,6 +373,7 @@ export interface RetryPolicy {
329
373
  MaximumRetryAttempts?: number;
330
374
  }
331
375
  /**
376
+ * @public
332
377
  * <p>The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.</p>
333
378
  */
334
379
  export interface SageMakerPipelineParameter {
@@ -342,6 +387,7 @@ export interface SageMakerPipelineParameter {
342
387
  Value: string | undefined;
343
388
  }
344
389
  /**
390
+ * @public
345
391
  * <p>The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html">
346
392
  * <code>StartPipelineExecution</code>
347
393
  * </a> API operation.</p>
@@ -353,6 +399,7 @@ export interface SageMakerPipelineParameters {
353
399
  PipelineParameterList?: SageMakerPipelineParameter[];
354
400
  }
355
401
  /**
402
+ * @public
356
403
  * <p>The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html">
357
404
  * <code>SendMessage</code>
358
405
  * </a> API operation.
@@ -368,6 +415,7 @@ export interface SqsParameters {
368
415
  MessageGroupId?: string;
369
416
  }
370
417
  /**
418
+ * @public
371
419
  * <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
372
420
  * invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.</p>
373
421
  */
@@ -428,6 +476,9 @@ export interface Target {
428
476
  */
429
477
  SqsParameters?: SqsParameters;
430
478
  }
479
+ /**
480
+ * @public
481
+ */
431
482
  export interface CreateScheduleInput {
432
483
  /**
433
484
  * <p>The name of the schedule that you are creating.</p>
@@ -518,6 +569,9 @@ export interface CreateScheduleInput {
518
569
  */
519
570
  ClientToken?: string;
520
571
  }
572
+ /**
573
+ * @public
574
+ */
521
575
  export interface CreateScheduleOutput {
522
576
  /**
523
577
  * <p>The Amazon Resource Name (ARN) of the schedule.</p>
@@ -525,6 +579,7 @@ export interface CreateScheduleOutput {
525
579
  ScheduleArn: string | undefined;
526
580
  }
527
581
  /**
582
+ * @public
528
583
  * <p>The request exceeds a service quota.</p>
529
584
  */
530
585
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -536,6 +591,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
536
591
  */
537
592
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
538
593
  }
594
+ /**
595
+ * @public
596
+ */
539
597
  export interface DeleteScheduleInput {
540
598
  /**
541
599
  * <p>The name of the schedule to delete.</p>
@@ -553,8 +611,14 @@ export interface DeleteScheduleInput {
553
611
  */
554
612
  ClientToken?: string;
555
613
  }
614
+ /**
615
+ * @public
616
+ */
556
617
  export interface DeleteScheduleOutput {
557
618
  }
619
+ /**
620
+ * @public
621
+ */
558
622
  export interface GetScheduleInput {
559
623
  /**
560
624
  * <p>The name of the schedule to retrieve.</p>
@@ -565,6 +629,9 @@ export interface GetScheduleInput {
565
629
  */
566
630
  GroupName?: string;
567
631
  }
632
+ /**
633
+ * @public
634
+ */
568
635
  export interface GetScheduleOutput {
569
636
  /**
570
637
  * <p>The Amazon Resource Name (ARN) of the schedule.</p>
@@ -660,6 +727,9 @@ export interface GetScheduleOutput {
660
727
  */
661
728
  FlexibleTimeWindow?: FlexibleTimeWindow;
662
729
  }
730
+ /**
731
+ * @public
732
+ */
663
733
  export interface ListSchedulesInput {
664
734
  /**
665
735
  * <p>If specified, only lists the schedules whose associated schedule group matches the given filter.</p>
@@ -683,6 +753,7 @@ export interface ListSchedulesInput {
683
753
  MaxResults?: number;
684
754
  }
685
755
  /**
756
+ * @public
686
757
  * <p>The details of a target.</p>
687
758
  */
688
759
  export interface TargetSummary {
@@ -692,6 +763,7 @@ export interface TargetSummary {
692
763
  Arn: string | undefined;
693
764
  }
694
765
  /**
766
+ * @public
695
767
  * <p>The details of a schedule.</p>
696
768
  */
697
769
  export interface ScheduleSummary {
@@ -724,6 +796,9 @@ export interface ScheduleSummary {
724
796
  */
725
797
  Target?: TargetSummary;
726
798
  }
799
+ /**
800
+ * @public
801
+ */
727
802
  export interface ListSchedulesOutput {
728
803
  /**
729
804
  * <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
@@ -734,6 +809,9 @@ export interface ListSchedulesOutput {
734
809
  */
735
810
  Schedules: ScheduleSummary[] | undefined;
736
811
  }
812
+ /**
813
+ * @public
814
+ */
737
815
  export interface UpdateScheduleInput {
738
816
  /**
739
817
  * <p>The name of the schedule that you are updating.</p>
@@ -825,12 +903,18 @@ export interface UpdateScheduleInput {
825
903
  */
826
904
  ClientToken?: string;
827
905
  }
906
+ /**
907
+ * @public
908
+ */
828
909
  export interface UpdateScheduleOutput {
829
910
  /**
830
911
  * <p>The Amazon Resource Name (ARN) of the schedule that you updated.</p>
831
912
  */
832
913
  ScheduleArn: string | undefined;
833
914
  }
915
+ /**
916
+ * @public
917
+ */
834
918
  export interface CreateScheduleGroupInput {
835
919
  /**
836
920
  * <p>The name of the schedule group that you are creating.</p>
@@ -848,12 +932,18 @@ export interface CreateScheduleGroupInput {
848
932
  */
849
933
  ClientToken?: string;
850
934
  }
935
+ /**
936
+ * @public
937
+ */
851
938
  export interface CreateScheduleGroupOutput {
852
939
  /**
853
940
  * <p>The Amazon Resource Name (ARN) of the schedule group.</p>
854
941
  */
855
942
  ScheduleGroupArn: string | undefined;
856
943
  }
944
+ /**
945
+ * @public
946
+ */
857
947
  export interface DeleteScheduleGroupInput {
858
948
  /**
859
949
  * <p>The name of the schedule group to delete.</p>
@@ -867,18 +957,30 @@ export interface DeleteScheduleGroupInput {
867
957
  */
868
958
  ClientToken?: string;
869
959
  }
960
+ /**
961
+ * @public
962
+ */
870
963
  export interface DeleteScheduleGroupOutput {
871
964
  }
965
+ /**
966
+ * @public
967
+ */
872
968
  export interface GetScheduleGroupInput {
873
969
  /**
874
970
  * <p>The name of the schedule group to retrieve.</p>
875
971
  */
876
972
  Name: string | undefined;
877
973
  }
974
+ /**
975
+ * @public
976
+ */
878
977
  export declare enum ScheduleGroupState {
879
978
  ACTIVE = "ACTIVE",
880
979
  DELETING = "DELETING"
881
980
  }
981
+ /**
982
+ * @public
983
+ */
882
984
  export interface GetScheduleGroupOutput {
883
985
  /**
884
986
  * <p>The Amazon Resource Name (ARN) of the schedule group.</p>
@@ -901,6 +1003,9 @@ export interface GetScheduleGroupOutput {
901
1003
  */
902
1004
  LastModificationDate?: Date;
903
1005
  }
1006
+ /**
1007
+ * @public
1008
+ */
904
1009
  export interface ListScheduleGroupsInput {
905
1010
  /**
906
1011
  * <p>The name prefix that you can use to return a filtered list of your schedule groups.</p>
@@ -916,6 +1021,7 @@ export interface ListScheduleGroupsInput {
916
1021
  MaxResults?: number;
917
1022
  }
918
1023
  /**
1024
+ * @public
919
1025
  * <p>The details of a schedule group.</p>
920
1026
  */
921
1027
  export interface ScheduleGroupSummary {
@@ -940,6 +1046,9 @@ export interface ScheduleGroupSummary {
940
1046
  */
941
1047
  LastModificationDate?: Date;
942
1048
  }
1049
+ /**
1050
+ * @public
1051
+ */
943
1052
  export interface ListScheduleGroupsOutput {
944
1053
  /**
945
1054
  * <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
@@ -950,6 +1059,9 @@ export interface ListScheduleGroupsOutput {
950
1059
  */
951
1060
  ScheduleGroups: ScheduleGroupSummary[] | undefined;
952
1061
  }
1062
+ /**
1063
+ * @public
1064
+ */
953
1065
  export interface TagResourceInput {
954
1066
  /**
955
1067
  * <p>The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.</p>
@@ -960,8 +1072,14 @@ export interface TagResourceInput {
960
1072
  */
961
1073
  Tags: Tag[] | undefined;
962
1074
  }
1075
+ /**
1076
+ * @public
1077
+ */
963
1078
  export interface TagResourceOutput {
964
1079
  }
1080
+ /**
1081
+ * @public
1082
+ */
965
1083
  export interface UntagResourceInput {
966
1084
  /**
967
1085
  * <p>The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.</p>
@@ -972,6 +1090,9 @@ export interface UntagResourceInput {
972
1090
  */
973
1091
  TagKeys: string[] | undefined;
974
1092
  }
1093
+ /**
1094
+ * @public
1095
+ */
975
1096
  export interface UntagResourceOutput {
976
1097
  }
977
1098
  /**
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { SchedulerClient } from "../SchedulerClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface SchedulerPaginationConfiguration extends PaginationConfiguration {
4
7
  client: SchedulerClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput } from "../commands/ListScheduleGroupsCommand";
3
3
  import { SchedulerPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListScheduleGroups(config: SchedulerPaginationConfiguration, input: ListScheduleGroupsCommandInput, ...additionalArguments: any): Paginator<ListScheduleGroupsCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListSchedulesCommandInput, ListSchedulesCommandOutput } from "../commands/ListSchedulesCommand";
3
3
  import { SchedulerPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListSchedules(config: SchedulerPaginationConfiguration, input: ListSchedulesCommandInput, ...additionalArguments: any): Paginator<ListSchedulesCommandOutput>;
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.296.0",
4
+ "version": "3.297.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",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",