@aws-sdk/client-scheduler 3.295.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
  }