@aws-sdk/client-synthetics 3.121.0 → 3.128.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +7 -7
- package/dist-cjs/Synthetics.js +120 -0
- package/dist-cjs/commands/AssociateResourceCommand.js +36 -0
- package/dist-cjs/commands/CreateGroupCommand.js +36 -0
- package/dist-cjs/commands/DeleteGroupCommand.js +36 -0
- package/dist-cjs/commands/DisassociateResourceCommand.js +36 -0
- package/dist-cjs/commands/GetGroupCommand.js +36 -0
- package/dist-cjs/commands/ListAssociatedGroupsCommand.js +36 -0
- package/dist-cjs/commands/ListGroupResourcesCommand.js +36 -0
- package/dist-cjs/commands/ListGroupsCommand.js +36 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/models/models_0.js +236 -58
- package/dist-cjs/pagination/ListAssociatedGroupsPaginator.js +36 -0
- package/dist-cjs/pagination/ListGroupResourcesPaginator.js +36 -0
- package/dist-cjs/pagination/ListGroupsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +874 -221
- package/dist-es/Synthetics.js +120 -0
- package/dist-es/commands/AssociateResourceCommand.js +39 -0
- package/dist-es/commands/CreateGroupCommand.js +39 -0
- package/dist-es/commands/DeleteGroupCommand.js +39 -0
- package/dist-es/commands/DisassociateResourceCommand.js +39 -0
- package/dist-es/commands/GetGroupCommand.js +39 -0
- package/dist-es/commands/ListAssociatedGroupsCommand.js +39 -0
- package/dist-es/commands/ListGroupResourcesCommand.js +39 -0
- package/dist-es/commands/ListGroupsCommand.js +39 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +189 -52
- package/dist-es/pagination/ListAssociatedGroupsPaginator.js +75 -0
- package/dist-es/pagination/ListGroupResourcesPaginator.js +75 -0
- package/dist-es/pagination/ListGroupsPaginator.js +75 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1088 -237
- package/dist-types/Synthetics.d.ts +90 -11
- package/dist-types/SyntheticsClient.d.ts +10 -2
- package/dist-types/commands/AssociateResourceCommand.d.ts +38 -0
- package/dist-types/commands/CreateCanaryCommand.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +47 -0
- package/dist-types/commands/DeleteCanaryCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGroupCommand.d.ts +39 -0
- package/dist-types/commands/DisassociateResourceCommand.d.ts +35 -0
- package/dist-types/commands/GetGroupCommand.d.ts +36 -0
- package/dist-types/commands/ListAssociatedGroupsCommand.d.ts +36 -0
- package/dist-types/commands/ListGroupResourcesCommand.d.ts +35 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +36 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/StopCanaryCommand.d.ts +1 -2
- package/dist-types/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCanaryCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +450 -52
- package/dist-types/pagination/ListAssociatedGroupsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListGroupResourcesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListGroupsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/Synthetics.d.ts +40 -0
- package/dist-types/ts3.4/SyntheticsClient.d.ts +10 -2
- package/dist-types/ts3.4/commands/AssociateResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DisassociateResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAssociatedGroupsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListGroupResourcesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +243 -27
- package/dist-types/ts3.4/pagination/ListAssociatedGroupsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListGroupResourcesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListGroupsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +26 -26
|
@@ -1,11 +1,19 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
|
+
import { AssociateResourceCommandInput, AssociateResourceCommandOutput } from "./commands/AssociateResourceCommand";
|
|
2
3
|
import { CreateCanaryCommandInput, CreateCanaryCommandOutput } from "./commands/CreateCanaryCommand";
|
|
4
|
+
import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand";
|
|
3
5
|
import { DeleteCanaryCommandInput, DeleteCanaryCommandOutput } from "./commands/DeleteCanaryCommand";
|
|
6
|
+
import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
|
|
4
7
|
import { DescribeCanariesCommandInput, DescribeCanariesCommandOutput } from "./commands/DescribeCanariesCommand";
|
|
5
8
|
import { DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput } from "./commands/DescribeCanariesLastRunCommand";
|
|
6
9
|
import { DescribeRuntimeVersionsCommandInput, DescribeRuntimeVersionsCommandOutput } from "./commands/DescribeRuntimeVersionsCommand";
|
|
10
|
+
import { DisassociateResourceCommandInput, DisassociateResourceCommandOutput } from "./commands/DisassociateResourceCommand";
|
|
7
11
|
import { GetCanaryCommandInput, GetCanaryCommandOutput } from "./commands/GetCanaryCommand";
|
|
8
12
|
import { GetCanaryRunsCommandInput, GetCanaryRunsCommandOutput } from "./commands/GetCanaryRunsCommand";
|
|
13
|
+
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
14
|
+
import { ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput } from "./commands/ListAssociatedGroupsCommand";
|
|
15
|
+
import { ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput } from "./commands/ListGroupResourcesCommand";
|
|
16
|
+
import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand";
|
|
9
17
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
10
18
|
import { StartCanaryCommandInput, StartCanaryCommandOutput } from "./commands/StartCanaryCommand";
|
|
11
19
|
import { StopCanaryCommandInput, StopCanaryCommandOutput } from "./commands/StopCanaryCommand";
|
|
@@ -32,6 +40,15 @@ import { SyntheticsClient } from "./SyntheticsClient";
|
|
|
32
40
|
* Considerations for Synthetics Canaries</a>.</p>
|
|
33
41
|
*/
|
|
34
42
|
export declare class Synthetics extends SyntheticsClient {
|
|
43
|
+
/**
|
|
44
|
+
* <p>Associates a canary with a group. Using groups can help you with
|
|
45
|
+
* managing and automating your canaries, and you can also view aggregated run results and statistics
|
|
46
|
+
* for all canaries in a group. </p>
|
|
47
|
+
* <p>You must run this operation in the Region where the canary exists.</p>
|
|
48
|
+
*/
|
|
49
|
+
associateResource(args: AssociateResourceCommandInput, options?: __HttpHandlerOptions): Promise<AssociateResourceCommandOutput>;
|
|
50
|
+
associateResource(args: AssociateResourceCommandInput, cb: (err: any, data?: AssociateResourceCommandOutput) => void): void;
|
|
51
|
+
associateResource(args: AssociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceCommandOutput) => void): void;
|
|
35
52
|
/**
|
|
36
53
|
* <p>Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the
|
|
37
54
|
* outside-in. Canaries help you check the availability and latency of your web services and
|
|
@@ -40,7 +57,7 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
40
57
|
* <p>Do not use <code>CreateCanary</code> to modify an existing canary. Use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html">UpdateCanary</a> instead.</p>
|
|
41
58
|
* <p>To create canaries, you must have the <code>CloudWatchSyntheticsFullAccess</code> policy.
|
|
42
59
|
* If you are creating a new IAM role for the canary, you also need the
|
|
43
|
-
*
|
|
60
|
+
* <code>iam:CreateRole</code>, <code>iam:CreatePolicy</code> and
|
|
44
61
|
* <code>iam:AttachRolePolicy</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles">Necessary
|
|
45
62
|
* Roles and Permissions</a>.</p>
|
|
46
63
|
* <p>Do not include secrets or proprietary information in your canary names. The canary name
|
|
@@ -51,11 +68,29 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
51
68
|
createCanary(args: CreateCanaryCommandInput, options?: __HttpHandlerOptions): Promise<CreateCanaryCommandOutput>;
|
|
52
69
|
createCanary(args: CreateCanaryCommandInput, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void;
|
|
53
70
|
createCanary(args: CreateCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void;
|
|
71
|
+
/**
|
|
72
|
+
* <p>Creates a group which you can use to associate canaries with each other, including cross-Region
|
|
73
|
+
* canaries. Using groups can help you with
|
|
74
|
+
* managing and automating your canaries, and you can also view aggregated run results and statistics
|
|
75
|
+
* for all canaries in a group. </p>
|
|
76
|
+
* <p>Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and
|
|
77
|
+
* you can view it and add canaries to it from any Region.
|
|
78
|
+
* Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region.
|
|
79
|
+
* This means that you can put canaries from multiple Regions into the same group, and then use
|
|
80
|
+
* that group to view and manage all of those canaries in a single view.</p>
|
|
81
|
+
* <p>Groups are supported in all Regions except the Regions that are disabled by default. For more information
|
|
82
|
+
* about these Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Enabling a Region</a>.</p>
|
|
83
|
+
* <p>Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary
|
|
84
|
+
* can be a member of up to 10 groups.</p>
|
|
85
|
+
*/
|
|
86
|
+
createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
|
|
87
|
+
createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
88
|
+
createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
54
89
|
/**
|
|
55
90
|
* <p>Permanently deletes the specified canary.</p>
|
|
56
91
|
* <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes
|
|
57
92
|
* the Lambda functions and layers that are used by the canary.</p>
|
|
58
|
-
* <p>Other
|
|
93
|
+
* <p>Other resources used and created by the canary are not automatically deleted.
|
|
59
94
|
* After you delete a canary that you do not intend to
|
|
60
95
|
* use again, you
|
|
61
96
|
* should also delete the following:</p>
|
|
@@ -89,6 +124,16 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
89
124
|
deleteCanary(args: DeleteCanaryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCanaryCommandOutput>;
|
|
90
125
|
deleteCanary(args: DeleteCanaryCommandInput, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void;
|
|
91
126
|
deleteCanary(args: DeleteCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void;
|
|
127
|
+
/**
|
|
128
|
+
* <p>Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group,
|
|
129
|
+
* they are not deleted when you delete the group.
|
|
130
|
+
* </p>
|
|
131
|
+
* <p>Groups are a global resource that appear in all Regions, but the request to delete a group
|
|
132
|
+
* must be made from its home Region. You can find the home Region of a group within its ARN.</p>
|
|
133
|
+
*/
|
|
134
|
+
deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
|
|
135
|
+
deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
136
|
+
deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
92
137
|
/**
|
|
93
138
|
* <p>This operation returns a list of the canaries in your account, along with full details
|
|
94
139
|
* about each canary.</p>
|
|
@@ -127,6 +172,12 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
127
172
|
describeRuntimeVersions(args: DescribeRuntimeVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRuntimeVersionsCommandOutput>;
|
|
128
173
|
describeRuntimeVersions(args: DescribeRuntimeVersionsCommandInput, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void): void;
|
|
129
174
|
describeRuntimeVersions(args: DescribeRuntimeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void): void;
|
|
175
|
+
/**
|
|
176
|
+
* <p>Removes a canary from a group. You must run this operation in the Region where the canary exists.</p>
|
|
177
|
+
*/
|
|
178
|
+
disassociateResource(args: DisassociateResourceCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateResourceCommandOutput>;
|
|
179
|
+
disassociateResource(args: DisassociateResourceCommandInput, cb: (err: any, data?: DisassociateResourceCommandOutput) => void): void;
|
|
180
|
+
disassociateResource(args: DisassociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceCommandOutput) => void): void;
|
|
130
181
|
/**
|
|
131
182
|
* <p>Retrieves complete information about one canary. You must specify
|
|
132
183
|
* the name of the canary that you want. To get a list of canaries
|
|
@@ -142,7 +193,34 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
142
193
|
getCanaryRuns(args: GetCanaryRunsCommandInput, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void): void;
|
|
143
194
|
getCanaryRuns(args: GetCanaryRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void): void;
|
|
144
195
|
/**
|
|
145
|
-
* <p>
|
|
196
|
+
* <p>Returns information about one group. Groups are a global resource, so you can use this operation from
|
|
197
|
+
* any Region.</p>
|
|
198
|
+
*/
|
|
199
|
+
getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupCommandOutput>;
|
|
200
|
+
getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
201
|
+
getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
202
|
+
/**
|
|
203
|
+
* <p>Returns a list of the groups that the specified canary is associated with. The canary
|
|
204
|
+
* that you specify must be in the current Region.</p>
|
|
205
|
+
*/
|
|
206
|
+
listAssociatedGroups(args: ListAssociatedGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssociatedGroupsCommandOutput>;
|
|
207
|
+
listAssociatedGroups(args: ListAssociatedGroupsCommandInput, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void): void;
|
|
208
|
+
listAssociatedGroups(args: ListAssociatedGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void): void;
|
|
209
|
+
/**
|
|
210
|
+
* <p>This operation returns a list of the ARNs of the canaries that are associated with the specified group.</p>
|
|
211
|
+
*/
|
|
212
|
+
listGroupResources(args: ListGroupResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupResourcesCommandOutput>;
|
|
213
|
+
listGroupResources(args: ListGroupResourcesCommandInput, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
|
|
214
|
+
listGroupResources(args: ListGroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
|
|
215
|
+
/**
|
|
216
|
+
* <p>Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups
|
|
217
|
+
* from all Regions are returned.</p>
|
|
218
|
+
*/
|
|
219
|
+
listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
|
|
220
|
+
listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
221
|
+
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
222
|
+
/**
|
|
223
|
+
* <p>Displays the tags associated with a canary or group.</p>
|
|
146
224
|
*/
|
|
147
225
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
148
226
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
@@ -156,8 +234,7 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
156
234
|
startCanary(args: StartCanaryCommandInput, cb: (err: any, data?: StartCanaryCommandOutput) => void): void;
|
|
157
235
|
startCanary(args: StartCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCanaryCommandOutput) => void): void;
|
|
158
236
|
/**
|
|
159
|
-
* <p>Stops the canary to prevent all future runs. If the canary is currently running,
|
|
160
|
-
* Synthetics stops waiting for the current run of the specified canary to complete. The
|
|
237
|
+
* <p>Stops the canary to prevent all future runs. If the canary is currently running,the
|
|
161
238
|
* run that is in progress completes on its own, publishes metrics, and uploads artifacts, but
|
|
162
239
|
* it is not recorded in Synthetics as a completed run.</p>
|
|
163
240
|
* <p>You can use <code>StartCanary</code> to start it running again
|
|
@@ -167,28 +244,30 @@ export declare class Synthetics extends SyntheticsClient {
|
|
|
167
244
|
stopCanary(args: StopCanaryCommandInput, cb: (err: any, data?: StopCanaryCommandOutput) => void): void;
|
|
168
245
|
stopCanary(args: StopCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCanaryCommandOutput) => void): void;
|
|
169
246
|
/**
|
|
170
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified canary. </p>
|
|
247
|
+
* <p>Assigns one or more tags (key-value pairs) to the specified canary or group. </p>
|
|
171
248
|
* <p>Tags can help you organize and categorize your
|
|
172
249
|
* resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
|
|
173
250
|
* certain tag values.</p>
|
|
174
251
|
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
|
|
175
|
-
* <p>You can use the <code>TagResource</code> action with a
|
|
252
|
+
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new
|
|
253
|
+
* tag key for the resource,
|
|
176
254
|
* this tag is appended to the list of tags associated
|
|
177
|
-
* with the
|
|
255
|
+
* with the resource. If you specify a tag key that is already associated with the resource, the new tag
|
|
256
|
+
* value that you specify replaces
|
|
178
257
|
* the previous value for that tag.</p>
|
|
179
|
-
* <p>You can associate as many as 50 tags with a canary.</p>
|
|
258
|
+
* <p>You can associate as many as 50 tags with a canary or group.</p>
|
|
180
259
|
*/
|
|
181
260
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
182
261
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
183
262
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
184
263
|
/**
|
|
185
|
-
* <p>Removes one or more tags from the specified
|
|
264
|
+
* <p>Removes one or more tags from the specified resource.</p>
|
|
186
265
|
*/
|
|
187
266
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
188
267
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
189
268
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
190
269
|
/**
|
|
191
|
-
* <p>
|
|
270
|
+
* <p>Updates the configuration of a canary that has
|
|
192
271
|
* already been created.</p>
|
|
193
272
|
* <p>You can't use this operation to update the tags of an existing canary. To
|
|
194
273
|
* change the tags of an existing canary, use
|
|
@@ -6,21 +6,29 @@ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middlewa
|
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
|
+
import { AssociateResourceCommandInput, AssociateResourceCommandOutput } from "./commands/AssociateResourceCommand";
|
|
9
10
|
import { CreateCanaryCommandInput, CreateCanaryCommandOutput } from "./commands/CreateCanaryCommand";
|
|
11
|
+
import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand";
|
|
10
12
|
import { DeleteCanaryCommandInput, DeleteCanaryCommandOutput } from "./commands/DeleteCanaryCommand";
|
|
13
|
+
import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
|
|
11
14
|
import { DescribeCanariesCommandInput, DescribeCanariesCommandOutput } from "./commands/DescribeCanariesCommand";
|
|
12
15
|
import { DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput } from "./commands/DescribeCanariesLastRunCommand";
|
|
13
16
|
import { DescribeRuntimeVersionsCommandInput, DescribeRuntimeVersionsCommandOutput } from "./commands/DescribeRuntimeVersionsCommand";
|
|
17
|
+
import { DisassociateResourceCommandInput, DisassociateResourceCommandOutput } from "./commands/DisassociateResourceCommand";
|
|
14
18
|
import { GetCanaryCommandInput, GetCanaryCommandOutput } from "./commands/GetCanaryCommand";
|
|
15
19
|
import { GetCanaryRunsCommandInput, GetCanaryRunsCommandOutput } from "./commands/GetCanaryRunsCommand";
|
|
20
|
+
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
21
|
+
import { ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput } from "./commands/ListAssociatedGroupsCommand";
|
|
22
|
+
import { ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput } from "./commands/ListGroupResourcesCommand";
|
|
23
|
+
import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand";
|
|
16
24
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
17
25
|
import { StartCanaryCommandInput, StartCanaryCommandOutput } from "./commands/StartCanaryCommand";
|
|
18
26
|
import { StopCanaryCommandInput, StopCanaryCommandOutput } from "./commands/StopCanaryCommand";
|
|
19
27
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
20
28
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
21
29
|
import { UpdateCanaryCommandInput, UpdateCanaryCommandOutput } from "./commands/UpdateCanaryCommand";
|
|
22
|
-
export declare type ServiceInputTypes = CreateCanaryCommandInput | DeleteCanaryCommandInput | DescribeCanariesCommandInput | DescribeCanariesLastRunCommandInput | DescribeRuntimeVersionsCommandInput | GetCanaryCommandInput | GetCanaryRunsCommandInput | ListTagsForResourceCommandInput | StartCanaryCommandInput | StopCanaryCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCanaryCommandInput;
|
|
23
|
-
export declare type ServiceOutputTypes = CreateCanaryCommandOutput | DeleteCanaryCommandOutput | DescribeCanariesCommandOutput | DescribeCanariesLastRunCommandOutput | DescribeRuntimeVersionsCommandOutput | GetCanaryCommandOutput | GetCanaryRunsCommandOutput | ListTagsForResourceCommandOutput | StartCanaryCommandOutput | StopCanaryCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCanaryCommandOutput;
|
|
30
|
+
export declare type ServiceInputTypes = AssociateResourceCommandInput | CreateCanaryCommandInput | CreateGroupCommandInput | DeleteCanaryCommandInput | DeleteGroupCommandInput | DescribeCanariesCommandInput | DescribeCanariesLastRunCommandInput | DescribeRuntimeVersionsCommandInput | DisassociateResourceCommandInput | GetCanaryCommandInput | GetCanaryRunsCommandInput | GetGroupCommandInput | ListAssociatedGroupsCommandInput | ListGroupResourcesCommandInput | ListGroupsCommandInput | ListTagsForResourceCommandInput | StartCanaryCommandInput | StopCanaryCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCanaryCommandInput;
|
|
31
|
+
export declare type ServiceOutputTypes = AssociateResourceCommandOutput | CreateCanaryCommandOutput | CreateGroupCommandOutput | DeleteCanaryCommandOutput | DeleteGroupCommandOutput | DescribeCanariesCommandOutput | DescribeCanariesLastRunCommandOutput | DescribeRuntimeVersionsCommandOutput | DisassociateResourceCommandOutput | GetCanaryCommandOutput | GetCanaryRunsCommandOutput | GetGroupCommandOutput | ListAssociatedGroupsCommandOutput | ListGroupResourcesCommandOutput | ListGroupsCommandOutput | ListTagsForResourceCommandOutput | StartCanaryCommandOutput | StopCanaryCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCanaryCommandOutput;
|
|
24
32
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
25
33
|
/**
|
|
26
34
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { AssociateResourceRequest, AssociateResourceResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface AssociateResourceCommandInput extends AssociateResourceRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface AssociateResourceCommandOutput extends AssociateResourceResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Associates a canary with a group. Using groups can help you with
|
|
11
|
+
* managing and automating your canaries, and you can also view aggregated run results and statistics
|
|
12
|
+
* for all canaries in a group. </p>
|
|
13
|
+
* <p>You must run this operation in the Region where the canary exists.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { SyntheticsClient, AssociateResourceCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
18
|
+
* // const { SyntheticsClient, AssociateResourceCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
19
|
+
* const client = new SyntheticsClient(config);
|
|
20
|
+
* const command = new AssociateResourceCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link AssociateResourceCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link AssociateResourceCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class AssociateResourceCommand extends $Command<AssociateResourceCommandInput, AssociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
|
|
30
|
+
readonly input: AssociateResourceCommandInput;
|
|
31
|
+
constructor(input: AssociateResourceCommandInput);
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateResourceCommandInput, AssociateResourceCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|
|
@@ -14,7 +14,7 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
|
|
|
14
14
|
* <p>Do not use <code>CreateCanary</code> to modify an existing canary. Use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html">UpdateCanary</a> instead.</p>
|
|
15
15
|
* <p>To create canaries, you must have the <code>CloudWatchSyntheticsFullAccess</code> policy.
|
|
16
16
|
* If you are creating a new IAM role for the canary, you also need the
|
|
17
|
-
*
|
|
17
|
+
* <code>iam:CreateRole</code>, <code>iam:CreatePolicy</code> and
|
|
18
18
|
* <code>iam:AttachRolePolicy</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles">Necessary
|
|
19
19
|
* Roles and Permissions</a>.</p>
|
|
20
20
|
* <p>Do not include secrets or proprietary information in your canary names. The canary name
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CreateGroupRequest, CreateGroupResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface CreateGroupCommandInput extends CreateGroupRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a group which you can use to associate canaries with each other, including cross-Region
|
|
11
|
+
* canaries. Using groups can help you with
|
|
12
|
+
* managing and automating your canaries, and you can also view aggregated run results and statistics
|
|
13
|
+
* for all canaries in a group. </p>
|
|
14
|
+
* <p>Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and
|
|
15
|
+
* you can view it and add canaries to it from any Region.
|
|
16
|
+
* Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region.
|
|
17
|
+
* This means that you can put canaries from multiple Regions into the same group, and then use
|
|
18
|
+
* that group to view and manage all of those canaries in a single view.</p>
|
|
19
|
+
* <p>Groups are supported in all Regions except the Regions that are disabled by default. For more information
|
|
20
|
+
* about these Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Enabling a Region</a>.</p>
|
|
21
|
+
* <p>Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary
|
|
22
|
+
* can be a member of up to 10 groups.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { SyntheticsClient, CreateGroupCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
27
|
+
* // const { SyntheticsClient, CreateGroupCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
28
|
+
* const client = new SyntheticsClient(config);
|
|
29
|
+
* const command = new CreateGroupCommand(input);
|
|
30
|
+
* const response = await client.send(command);
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
33
|
+
* @see {@link CreateGroupCommandInput} for command's `input` shape.
|
|
34
|
+
* @see {@link CreateGroupCommandOutput} for command's `response` shape.
|
|
35
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, SyntheticsClientResolvedConfig> {
|
|
39
|
+
readonly input: CreateGroupCommandInput;
|
|
40
|
+
constructor(input: CreateGroupCommandInput);
|
|
41
|
+
/**
|
|
42
|
+
* @internal
|
|
43
|
+
*/
|
|
44
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
|
|
45
|
+
private serialize;
|
|
46
|
+
private deserialize;
|
|
47
|
+
}
|
|
@@ -10,7 +10,7 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad
|
|
|
10
10
|
* <p>Permanently deletes the specified canary.</p>
|
|
11
11
|
* <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes
|
|
12
12
|
* the Lambda functions and layers that are used by the canary.</p>
|
|
13
|
-
* <p>Other
|
|
13
|
+
* <p>Other resources used and created by the canary are not automatically deleted.
|
|
14
14
|
* After you delete a canary that you do not intend to
|
|
15
15
|
* use again, you
|
|
16
16
|
* should also delete the following:</p>
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DeleteGroupRequest, DeleteGroupResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface DeleteGroupCommandInput extends DeleteGroupRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group,
|
|
11
|
+
* they are not deleted when you delete the group.
|
|
12
|
+
* </p>
|
|
13
|
+
* <p>Groups are a global resource that appear in all Regions, but the request to delete a group
|
|
14
|
+
* must be made from its home Region. You can find the home Region of a group within its ARN.</p>
|
|
15
|
+
* @example
|
|
16
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
17
|
+
* ```javascript
|
|
18
|
+
* import { SyntheticsClient, DeleteGroupCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
19
|
+
* // const { SyntheticsClient, DeleteGroupCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
20
|
+
* const client = new SyntheticsClient(config);
|
|
21
|
+
* const command = new DeleteGroupCommand(input);
|
|
22
|
+
* const response = await client.send(command);
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @see {@link DeleteGroupCommandInput} for command's `input` shape.
|
|
26
|
+
* @see {@link DeleteGroupCommandOutput} for command's `response` shape.
|
|
27
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, SyntheticsClientResolvedConfig> {
|
|
31
|
+
readonly input: DeleteGroupCommandInput;
|
|
32
|
+
constructor(input: DeleteGroupCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupCommandInput, DeleteGroupCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DisassociateResourceRequest, DisassociateResourceResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface DisassociateResourceCommandInput extends DisassociateResourceRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DisassociateResourceCommandOutput extends DisassociateResourceResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Removes a canary from a group. You must run this operation in the Region where the canary exists.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { SyntheticsClient, DisassociateResourceCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
15
|
+
* // const { SyntheticsClient, DisassociateResourceCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
16
|
+
* const client = new SyntheticsClient(config);
|
|
17
|
+
* const command = new DisassociateResourceCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link DisassociateResourceCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link DisassociateResourceCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class DisassociateResourceCommand extends $Command<DisassociateResourceCommandInput, DisassociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
|
|
27
|
+
readonly input: DisassociateResourceCommandInput;
|
|
28
|
+
constructor(input: DisassociateResourceCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateResourceCommandInput, DisassociateResourceCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { GetGroupRequest, GetGroupResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface GetGroupCommandInput extends GetGroupRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Returns information about one group. Groups are a global resource, so you can use this operation from
|
|
11
|
+
* any Region.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { SyntheticsClient, GetGroupCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
16
|
+
* // const { SyntheticsClient, GetGroupCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
17
|
+
* const client = new SyntheticsClient(config);
|
|
18
|
+
* const command = new GetGroupCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link GetGroupCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link GetGroupCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, SyntheticsClientResolvedConfig> {
|
|
28
|
+
readonly input: GetGroupCommandInput;
|
|
29
|
+
constructor(input: GetGroupCommandInput);
|
|
30
|
+
/**
|
|
31
|
+
* @internal
|
|
32
|
+
*/
|
|
33
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGroupCommandInput, GetGroupCommandOutput>;
|
|
34
|
+
private serialize;
|
|
35
|
+
private deserialize;
|
|
36
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListAssociatedGroupsRequest, ListAssociatedGroupsResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface ListAssociatedGroupsCommandInput extends ListAssociatedGroupsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Returns a list of the groups that the specified canary is associated with. The canary
|
|
11
|
+
* that you specify must be in the current Region.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { SyntheticsClient, ListAssociatedGroupsCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
16
|
+
* // const { SyntheticsClient, ListAssociatedGroupsCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
17
|
+
* const client = new SyntheticsClient(config);
|
|
18
|
+
* const command = new ListAssociatedGroupsCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link ListAssociatedGroupsCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link ListAssociatedGroupsCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class ListAssociatedGroupsCommand extends $Command<ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput, SyntheticsClientResolvedConfig> {
|
|
28
|
+
readonly input: ListAssociatedGroupsCommandInput;
|
|
29
|
+
constructor(input: ListAssociatedGroupsCommandInput);
|
|
30
|
+
/**
|
|
31
|
+
* @internal
|
|
32
|
+
*/
|
|
33
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput>;
|
|
34
|
+
private serialize;
|
|
35
|
+
private deserialize;
|
|
36
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListGroupResourcesRequest, ListGroupResourcesResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface ListGroupResourcesCommandInput extends ListGroupResourcesRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListGroupResourcesCommandOutput extends ListGroupResourcesResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>This operation returns a list of the ARNs of the canaries that are associated with the specified group.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { SyntheticsClient, ListGroupResourcesCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
15
|
+
* // const { SyntheticsClient, ListGroupResourcesCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
16
|
+
* const client = new SyntheticsClient(config);
|
|
17
|
+
* const command = new ListGroupResourcesCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link ListGroupResourcesCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link ListGroupResourcesCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class ListGroupResourcesCommand extends $Command<ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput, SyntheticsClientResolvedConfig> {
|
|
27
|
+
readonly input: ListGroupResourcesCommandInput;
|
|
28
|
+
constructor(input: ListGroupResourcesCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListGroupsRequest, ListGroupsResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
|
|
5
|
+
export interface ListGroupsCommandInput extends ListGroupsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups
|
|
11
|
+
* from all Regions are returned.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { SyntheticsClient, ListGroupsCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
|
|
16
|
+
* // const { SyntheticsClient, ListGroupsCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
|
|
17
|
+
* const client = new SyntheticsClient(config);
|
|
18
|
+
* const command = new ListGroupsCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link ListGroupsCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link ListGroupsCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, SyntheticsClientResolvedConfig> {
|
|
28
|
+
readonly input: ListGroupsCommandInput;
|
|
29
|
+
constructor(input: ListGroupsCommandInput);
|
|
30
|
+
/**
|
|
31
|
+
* @internal
|
|
32
|
+
*/
|
|
33
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupsCommandInput, ListGroupsCommandOutput>;
|
|
34
|
+
private serialize;
|
|
35
|
+
private deserialize;
|
|
36
|
+
}
|
|
@@ -7,7 +7,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
|
|
|
7
7
|
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Displays the tags associated with a canary.</p>
|
|
10
|
+
* <p>Displays the tags associated with a canary or group.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface StopCanaryCommandInput extends StopCanaryRequest {
|
|
|
7
7
|
export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Stops the canary to prevent all future runs. If the canary is currently running,
|
|
11
|
-
* Synthetics stops waiting for the current run of the specified canary to complete. The
|
|
10
|
+
* <p>Stops the canary to prevent all future runs. If the canary is currently running,the
|
|
12
11
|
* run that is in progress completes on its own, publishes metrics, and uploads artifacts, but
|
|
13
12
|
* it is not recorded in Synthetics as a completed run.</p>
|
|
14
13
|
* <p>You can use <code>StartCanary</code> to start it running again
|
|
@@ -7,16 +7,18 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified canary. </p>
|
|
10
|
+
* <p>Assigns one or more tags (key-value pairs) to the specified canary or group. </p>
|
|
11
11
|
* <p>Tags can help you organize and categorize your
|
|
12
12
|
* resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
|
|
13
13
|
* certain tag values.</p>
|
|
14
14
|
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
|
|
15
|
-
* <p>You can use the <code>TagResource</code> action with a
|
|
15
|
+
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new
|
|
16
|
+
* tag key for the resource,
|
|
16
17
|
* this tag is appended to the list of tags associated
|
|
17
|
-
* with the
|
|
18
|
+
* with the resource. If you specify a tag key that is already associated with the resource, the new tag
|
|
19
|
+
* value that you specify replaces
|
|
18
20
|
* the previous value for that tag.</p>
|
|
19
|
-
* <p>You can associate as many as 50 tags with a canary.</p>
|
|
21
|
+
* <p>You can associate as many as 50 tags with a canary or group.</p>
|
|
20
22
|
* @example
|
|
21
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
24
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
7
7
|
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes one or more tags from the specified
|
|
10
|
+
* <p>Removes one or more tags from the specified resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|