@aws-sdk/client-synthetics 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.
Files changed (34) hide show
  1. package/dist-types/Synthetics.d.ts +22 -0
  2. package/dist-types/SyntheticsClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateResourceCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateCanaryCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteCanaryCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeCanariesCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeCanariesLastRunCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeRuntimeVersionsCommand.d.ts +16 -0
  11. package/dist-types/commands/DisassociateResourceCommand.d.ts +16 -0
  12. package/dist-types/commands/GetCanaryCommand.d.ts +16 -0
  13. package/dist-types/commands/GetCanaryRunsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAssociatedGroupsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListGroupResourcesCommand.d.ts +16 -0
  17. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/StartCanaryCommand.d.ts +16 -0
  20. package/dist-types/commands/StopCanaryCommand.d.ts +16 -0
  21. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateCanaryCommand.d.ts +16 -0
  24. package/dist-types/models/SyntheticsServiceException.d.ts +2 -0
  25. package/dist-types/models/models_0.d.ts +176 -1
  26. package/dist-types/pagination/DescribeCanariesLastRunPaginator.d.ts +3 -0
  27. package/dist-types/pagination/DescribeCanariesPaginator.d.ts +3 -0
  28. package/dist-types/pagination/DescribeRuntimeVersionsPaginator.d.ts +3 -0
  29. package/dist-types/pagination/GetCanaryRunsPaginator.d.ts +3 -0
  30. package/dist-types/pagination/Interfaces.d.ts +3 -0
  31. package/dist-types/pagination/ListAssociatedGroupsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListGroupResourcesPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListGroupsPaginator.d.ts +3 -0
  34. package/package.json +3 -3
@@ -22,6 +22,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
22
22
  import { UpdateCanaryCommandInput, UpdateCanaryCommandOutput } from "./commands/UpdateCanaryCommand";
23
23
  import { SyntheticsClient } from "./SyntheticsClient";
24
24
  /**
25
+ * @public
25
26
  * <fullname>Amazon CloudWatch Synthetics</fullname>
26
27
  * <p>You can use Amazon CloudWatch Synthetics to continually monitor your services. You can
27
28
  * create and manage <i>canaries</i>, which are modular, lightweight scripts
@@ -41,6 +42,7 @@ import { SyntheticsClient } from "./SyntheticsClient";
41
42
  */
42
43
  export declare class Synthetics extends SyntheticsClient {
43
44
  /**
45
+ * @public
44
46
  * <p>Associates a canary with a group. Using groups can help you with
45
47
  * managing and automating your canaries, and you can also view aggregated run results and statistics
46
48
  * for all canaries in a group. </p>
@@ -50,6 +52,7 @@ export declare class Synthetics extends SyntheticsClient {
50
52
  associateResource(args: AssociateResourceCommandInput, cb: (err: any, data?: AssociateResourceCommandOutput) => void): void;
51
53
  associateResource(args: AssociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceCommandOutput) => void): void;
52
54
  /**
55
+ * @public
53
56
  * <p>Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the
54
57
  * outside-in. Canaries help you check the availability and latency of your web services and
55
58
  * troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and
@@ -69,6 +72,7 @@ export declare class Synthetics extends SyntheticsClient {
69
72
  createCanary(args: CreateCanaryCommandInput, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void;
70
73
  createCanary(args: CreateCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void;
71
74
  /**
75
+ * @public
72
76
  * <p>Creates a group which you can use to associate canaries with each other, including cross-Region
73
77
  * canaries. Using groups can help you with
74
78
  * managing and automating your canaries, and you can also view aggregated run results and statistics
@@ -87,6 +91,7 @@ export declare class Synthetics extends SyntheticsClient {
87
91
  createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
88
92
  createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
89
93
  /**
94
+ * @public
90
95
  * <p>Permanently deletes the specified canary.</p>
91
96
  * <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes
92
97
  * the Lambda functions and layers that are used by the canary.</p>
@@ -125,6 +130,7 @@ export declare class Synthetics extends SyntheticsClient {
125
130
  deleteCanary(args: DeleteCanaryCommandInput, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void;
126
131
  deleteCanary(args: DeleteCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void;
127
132
  /**
133
+ * @public
128
134
  * <p>Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group,
129
135
  * they are not deleted when you delete the group.
130
136
  * </p>
@@ -135,6 +141,7 @@ export declare class Synthetics extends SyntheticsClient {
135
141
  deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
136
142
  deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
137
143
  /**
144
+ * @public
138
145
  * <p>This operation returns a list of the canaries in your account, along with full details
139
146
  * about each canary.</p>
140
147
  * <p>This operation supports resource-level authorization using an IAM policy and
@@ -150,6 +157,7 @@ export declare class Synthetics extends SyntheticsClient {
150
157
  describeCanaries(args: DescribeCanariesCommandInput, cb: (err: any, data?: DescribeCanariesCommandOutput) => void): void;
151
158
  describeCanaries(args: DescribeCanariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCanariesCommandOutput) => void): void;
152
159
  /**
160
+ * @public
153
161
  * <p>Use this operation to see information from the most recent run of each canary that you have created.</p>
154
162
  *
155
163
  * <p>This operation supports resource-level authorization using an IAM policy and
@@ -165,6 +173,7 @@ export declare class Synthetics extends SyntheticsClient {
165
173
  describeCanariesLastRun(args: DescribeCanariesLastRunCommandInput, cb: (err: any, data?: DescribeCanariesLastRunCommandOutput) => void): void;
166
174
  describeCanariesLastRun(args: DescribeCanariesLastRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCanariesLastRunCommandOutput) => void): void;
167
175
  /**
176
+ * @public
168
177
  * <p>Returns a list of Synthetics canary runtime versions. For more information,
169
178
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html">
170
179
  * Canary Runtime Versions</a>.</p>
@@ -173,12 +182,14 @@ export declare class Synthetics extends SyntheticsClient {
173
182
  describeRuntimeVersions(args: DescribeRuntimeVersionsCommandInput, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void): void;
174
183
  describeRuntimeVersions(args: DescribeRuntimeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void): void;
175
184
  /**
185
+ * @public
176
186
  * <p>Removes a canary from a group. You must run this operation in the Region where the canary exists.</p>
177
187
  */
178
188
  disassociateResource(args: DisassociateResourceCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateResourceCommandOutput>;
179
189
  disassociateResource(args: DisassociateResourceCommandInput, cb: (err: any, data?: DisassociateResourceCommandOutput) => void): void;
180
190
  disassociateResource(args: DisassociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceCommandOutput) => void): void;
181
191
  /**
192
+ * @public
182
193
  * <p>Retrieves complete information about one canary. You must specify
183
194
  * the name of the canary that you want. To get a list of canaries
184
195
  * and their names, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
@@ -187,12 +198,14 @@ export declare class Synthetics extends SyntheticsClient {
187
198
  getCanary(args: GetCanaryCommandInput, cb: (err: any, data?: GetCanaryCommandOutput) => void): void;
188
199
  getCanary(args: GetCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCanaryCommandOutput) => void): void;
189
200
  /**
201
+ * @public
190
202
  * <p>Retrieves a list of runs for a specified canary.</p>
191
203
  */
192
204
  getCanaryRuns(args: GetCanaryRunsCommandInput, options?: __HttpHandlerOptions): Promise<GetCanaryRunsCommandOutput>;
193
205
  getCanaryRuns(args: GetCanaryRunsCommandInput, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void): void;
194
206
  getCanaryRuns(args: GetCanaryRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void): void;
195
207
  /**
208
+ * @public
196
209
  * <p>Returns information about one group. Groups are a global resource, so you can use this operation from
197
210
  * any Region.</p>
198
211
  */
@@ -200,6 +213,7 @@ export declare class Synthetics extends SyntheticsClient {
200
213
  getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
201
214
  getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
202
215
  /**
216
+ * @public
203
217
  * <p>Returns a list of the groups that the specified canary is associated with. The canary
204
218
  * that you specify must be in the current Region.</p>
205
219
  */
@@ -207,12 +221,14 @@ export declare class Synthetics extends SyntheticsClient {
207
221
  listAssociatedGroups(args: ListAssociatedGroupsCommandInput, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void): void;
208
222
  listAssociatedGroups(args: ListAssociatedGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void): void;
209
223
  /**
224
+ * @public
210
225
  * <p>This operation returns a list of the ARNs of the canaries that are associated with the specified group.</p>
211
226
  */
212
227
  listGroupResources(args: ListGroupResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupResourcesCommandOutput>;
213
228
  listGroupResources(args: ListGroupResourcesCommandInput, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
214
229
  listGroupResources(args: ListGroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
215
230
  /**
231
+ * @public
216
232
  * <p>Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups
217
233
  * from all Regions are returned.</p>
218
234
  */
@@ -220,12 +236,14 @@ export declare class Synthetics extends SyntheticsClient {
220
236
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
221
237
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
222
238
  /**
239
+ * @public
223
240
  * <p>Displays the tags associated with a canary or group.</p>
224
241
  */
225
242
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
226
243
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
227
244
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
228
245
  /**
246
+ * @public
229
247
  * <p>Use this operation to run a canary that has already been created.
230
248
  * The frequency of the canary runs is determined by the value of the canary's <code>Schedule</code>. To see a canary's schedule,
231
249
  * use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html">GetCanary</a>.</p>
@@ -234,6 +252,7 @@ export declare class Synthetics extends SyntheticsClient {
234
252
  startCanary(args: StartCanaryCommandInput, cb: (err: any, data?: StartCanaryCommandOutput) => void): void;
235
253
  startCanary(args: StartCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCanaryCommandOutput) => void): void;
236
254
  /**
255
+ * @public
237
256
  * <p>Stops the canary to prevent all future runs. If the canary is currently running,the
238
257
  * run that is in progress completes on its own, publishes metrics, and uploads artifacts, but
239
258
  * it is not recorded in Synthetics as a completed run.</p>
@@ -244,6 +263,7 @@ export declare class Synthetics extends SyntheticsClient {
244
263
  stopCanary(args: StopCanaryCommandInput, cb: (err: any, data?: StopCanaryCommandOutput) => void): void;
245
264
  stopCanary(args: StopCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCanaryCommandOutput) => void): void;
246
265
  /**
266
+ * @public
247
267
  * <p>Assigns one or more tags (key-value pairs) to the specified canary or group. </p>
248
268
  * <p>Tags can help you organize and categorize your
249
269
  * resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
@@ -261,12 +281,14 @@ export declare class Synthetics extends SyntheticsClient {
261
281
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
262
282
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
263
283
  /**
284
+ * @public
264
285
  * <p>Removes one or more tags from the specified resource.</p>
265
286
  */
266
287
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
267
288
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
268
289
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
269
290
  /**
291
+ * @public
270
292
  * <p>Updates the configuration of a canary that has
271
293
  * already been created.</p>
272
294
  * <p>You can't use this operation to update the tags of an existing canary. To
@@ -29,15 +29,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
29
29
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
30
30
  import { UpdateCanaryCommandInput, UpdateCanaryCommandOutput } from "./commands/UpdateCanaryCommand";
31
31
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
32
+ /**
33
+ * @public
34
+ */
32
35
  export type ServiceInputTypes = AssociateResourceCommandInput | CreateCanaryCommandInput | CreateGroupCommandInput | DeleteCanaryCommandInput | DeleteGroupCommandInput | DescribeCanariesCommandInput | DescribeCanariesLastRunCommandInput | DescribeRuntimeVersionsCommandInput | DisassociateResourceCommandInput | GetCanaryCommandInput | GetCanaryRunsCommandInput | GetGroupCommandInput | ListAssociatedGroupsCommandInput | ListGroupResourcesCommandInput | ListGroupsCommandInput | ListTagsForResourceCommandInput | StartCanaryCommandInput | StopCanaryCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCanaryCommandInput;
36
+ /**
37
+ * @public
38
+ */
33
39
  export type ServiceOutputTypes = AssociateResourceCommandOutput | CreateCanaryCommandOutput | CreateGroupCommandOutput | DeleteCanaryCommandOutput | DeleteGroupCommandOutput | DescribeCanariesCommandOutput | DescribeCanariesLastRunCommandOutput | DescribeRuntimeVersionsCommandOutput | DisassociateResourceCommandOutput | GetCanaryCommandOutput | GetCanaryRunsCommandOutput | GetGroupCommandOutput | ListAssociatedGroupsCommandOutput | ListGroupResourcesCommandOutput | ListGroupsCommandOutput | ListTagsForResourceCommandOutput | StartCanaryCommandOutput | StopCanaryCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCanaryCommandOutput;
40
+ /**
41
+ * @public
42
+ */
34
43
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
35
44
  /**
36
45
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
37
46
  */
38
47
  requestHandler?: __HttpHandler;
39
48
  /**
40
- * A constructor for a class implementing the {@link __Checksum} interface
49
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
41
50
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
42
51
  * @internal
43
52
  */
@@ -127,23 +136,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
127
136
  */
128
137
  logger?: __Logger;
129
138
  /**
130
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
139
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
140
  */
132
141
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
133
142
  }
143
+ /**
144
+ * @public
145
+ */
134
146
  type SyntheticsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
135
147
  /**
136
- * The configuration interface of SyntheticsClient class constructor that set the region, credentials and other options.
148
+ * @public
149
+ *
150
+ * The configuration interface of SyntheticsClient class constructor that set the region, credentials and other options.
137
151
  */
138
152
  export interface SyntheticsClientConfig extends SyntheticsClientConfigType {
139
153
  }
154
+ /**
155
+ * @public
156
+ */
140
157
  type SyntheticsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
141
158
  /**
142
- * The resolved configuration interface of SyntheticsClient class. This is resolved and normalized from the {@link SyntheticsClientConfig | constructor configuration interface}.
159
+ * @public
160
+ *
161
+ * The resolved configuration interface of SyntheticsClient class. This is resolved and normalized from the {@link SyntheticsClientConfig | constructor configuration interface}.
143
162
  */
144
163
  export interface SyntheticsClientResolvedConfig extends SyntheticsClientResolvedConfigType {
145
164
  }
146
165
  /**
166
+ * @public
147
167
  * <fullname>Amazon CloudWatch Synthetics</fullname>
148
168
  * <p>You can use Amazon CloudWatch Synthetics to continually monitor your services. You can
149
169
  * create and manage <i>canaries</i>, which are modular, lightweight scripts
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateResourceRequest, AssociateResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateResourceCommand}.
8
10
  */
9
11
  export interface AssociateResourceCommandInput extends AssociateResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateResourceCommand}.
13
17
  */
14
18
  export interface AssociateResourceCommandOutput extends AssociateResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Associates a canary with a group. Using groups can help you with
18
23
  * managing and automating your canaries, and you can also view aggregated run results and statistics
19
24
  * for all canaries in a group. </p>
@@ -28,6 +33,8 @@ export interface AssociateResourceCommandOutput extends AssociateResourceRespons
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param AssociateResourceCommandInput - {@link AssociateResourceCommandInput}
37
+ * @returns {@link AssociateResourceCommandOutput}
31
38
  * @see {@link AssociateResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link AssociateResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface AssociateResourceCommandOutput extends AssociateResourceRespons
52
59
  export declare class AssociateResourceCommand extends $Command<AssociateResourceCommandInput, AssociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
53
60
  readonly input: AssociateResourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: AssociateResourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateResourceCommandInput, AssociateResourceCommandOutput>;
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 { CreateCanaryRequest, CreateCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCanaryCommand}.
8
10
  */
9
11
  export interface CreateCanaryCommandInput extends CreateCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCanaryCommand}.
13
17
  */
14
18
  export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the
18
23
  * outside-in. Canaries help you check the availability and latency of your web services and
19
24
  * troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and
@@ -38,6 +43,8 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param CreateCanaryCommandInput - {@link CreateCanaryCommandInput}
47
+ * @returns {@link CreateCanaryCommandOutput}
41
48
  * @see {@link CreateCanaryCommandInput} for command's `input` shape.
42
49
  * @see {@link CreateCanaryCommandOutput} for command's `response` shape.
43
50
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
56
63
  export declare class CreateCanaryCommand extends $Command<CreateCanaryCommandInput, CreateCanaryCommandOutput, SyntheticsClientResolvedConfig> {
57
64
  readonly input: CreateCanaryCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateCanaryCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCanaryCommandInput, CreateCanaryCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateGroupRequest, CreateGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGroupCommand}.
8
10
  */
9
11
  export interface CreateGroupCommandInput extends CreateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGroupCommand}.
13
17
  */
14
18
  export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a group which you can use to associate canaries with each other, including cross-Region
18
23
  * canaries. Using groups can help you with
19
24
  * managing and automating your canaries, and you can also view aggregated run results and statistics
@@ -37,6 +42,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
46
+ * @returns {@link CreateGroupCommandOutput}
40
47
  * @see {@link CreateGroupCommandInput} for command's `input` shape.
41
48
  * @see {@link CreateGroupCommandOutput} for command's `response` shape.
42
49
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -58,11 +65,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
58
65
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, SyntheticsClientResolvedConfig> {
59
66
  readonly input: CreateGroupCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: CreateGroupCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteCanaryRequest, DeleteCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCanaryCommand}.
8
10
  */
9
11
  export interface DeleteCanaryCommandInput extends DeleteCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCanaryCommand}.
13
17
  */
14
18
  export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Permanently deletes the specified canary.</p>
18
23
  * <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes
19
24
  * the Lambda functions and layers that are used by the canary.</p>
@@ -57,6 +62,8 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad
57
62
  * const response = await client.send(command);
58
63
  * ```
59
64
  *
65
+ * @param DeleteCanaryCommandInput - {@link DeleteCanaryCommandInput}
66
+ * @returns {@link DeleteCanaryCommandOutput}
60
67
  * @see {@link DeleteCanaryCommandInput} for command's `input` shape.
61
68
  * @see {@link DeleteCanaryCommandOutput} for command's `response` shape.
62
69
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -78,11 +85,20 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad
78
85
  export declare class DeleteCanaryCommand extends $Command<DeleteCanaryCommandInput, DeleteCanaryCommandOutput, SyntheticsClientResolvedConfig> {
79
86
  readonly input: DeleteCanaryCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: DeleteCanaryCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCanaryCommandInput, DeleteCanaryCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteGroupRequest, DeleteGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGroupCommand}.
8
10
  */
9
11
  export interface DeleteGroupCommandInput extends DeleteGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGroupCommand}.
13
17
  */
14
18
  export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group,
18
23
  * they are not deleted when you delete the group.
19
24
  * </p>
@@ -29,6 +34,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
38
+ * @returns {@link DeleteGroupCommandOutput}
32
39
  * @see {@link DeleteGroupCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteGroupCommandOutput} for command's `response` shape.
34
41
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
50
57
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, SyntheticsClientResolvedConfig> {
51
58
  readonly input: DeleteGroupCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteGroupCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupCommandInput, DeleteGroupCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCanariesRequest, DescribeCanariesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCanariesCommand}.
8
10
  */
9
11
  export interface DescribeCanariesCommandInput extends DescribeCanariesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCanariesCommand}.
13
17
  */
14
18
  export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation returns a list of the canaries in your account, along with full details
18
23
  * about each canary.</p>
19
24
  * <p>This operation supports resource-level authorization using an IAM policy and
@@ -34,6 +39,8 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DescribeCanariesCommandInput - {@link DescribeCanariesCommandInput}
43
+ * @returns {@link DescribeCanariesCommandOutput}
37
44
  * @see {@link DescribeCanariesCommandInput} for command's `input` shape.
38
45
  * @see {@link DescribeCanariesCommandOutput} for command's `response` shape.
39
46
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
49
56
  export declare class DescribeCanariesCommand extends $Command<DescribeCanariesCommandInput, DescribeCanariesCommandOutput, SyntheticsClientResolvedConfig> {
50
57
  readonly input: DescribeCanariesCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeCanariesCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCanariesCommandInput, DescribeCanariesCommandOutput>;
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 { DescribeCanariesLastRunRequest, DescribeCanariesLastRunResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCanariesLastRunCommand}.
8
10
  */
9
11
  export interface DescribeCanariesLastRunCommandInput extends DescribeCanariesLastRunRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCanariesLastRunCommand}.
13
17
  */
14
18
  export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLastRunResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use this operation to see information from the most recent run of each canary that you have created.</p>
18
23
  *
19
24
  * <p>This operation supports resource-level authorization using an IAM policy and
@@ -34,6 +39,8 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DescribeCanariesLastRunCommandInput - {@link DescribeCanariesLastRunCommandInput}
43
+ * @returns {@link DescribeCanariesLastRunCommandOutput}
37
44
  * @see {@link DescribeCanariesLastRunCommandInput} for command's `input` shape.
38
45
  * @see {@link DescribeCanariesLastRunCommandOutput} for command's `response` shape.
39
46
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
49
56
  export declare class DescribeCanariesLastRunCommand extends $Command<DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput, SyntheticsClientResolvedConfig> {
50
57
  readonly input: DescribeCanariesLastRunCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeCanariesLastRunCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput>;
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 { DescribeRuntimeVersionsRequest, DescribeRuntimeVersionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRuntimeVersionsCommand}.
8
10
  */
9
11
  export interface DescribeRuntimeVersionsCommandInput extends DescribeRuntimeVersionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRuntimeVersionsCommand}.
13
17
  */
14
18
  export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVersionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Synthetics canary runtime versions. For more information,
18
23
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html">
19
24
  * Canary Runtime Versions</a>.</p>
@@ -27,6 +32,8 @@ export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVer
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeRuntimeVersionsCommandInput - {@link DescribeRuntimeVersionsCommandInput}
36
+ * @returns {@link DescribeRuntimeVersionsCommandOutput}
30
37
  * @see {@link DescribeRuntimeVersionsCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeRuntimeVersionsCommandOutput} for command's `response` shape.
32
39
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVer
42
49
  export declare class DescribeRuntimeVersionsCommand extends $Command<DescribeRuntimeVersionsCommandInput, DescribeRuntimeVersionsCommandOutput, SyntheticsClientResolvedConfig> {
43
50
  readonly input: DescribeRuntimeVersionsCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeRuntimeVersionsCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRuntimeVersionsCommandInput, DescribeRuntimeVersionsCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }