@aws-sdk/client-synthetics 3.118.1 → 3.127.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 +30 -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 +939 -274
- 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 +1116 -253
- 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
|
@@ -7,7 +7,7 @@ export interface UpdateCanaryCommandInput extends UpdateCanaryRequest {
|
|
|
7
7
|
export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Updates the configuration of a canary that has
|
|
11
11
|
* already been created.</p>
|
|
12
12
|
* <p>You can't use this operation to update the tags of an existing canary. To
|
|
13
13
|
* change the tags of an existing canary, use
|
|
@@ -1,10 +1,18 @@
|
|
|
1
|
+
export * from "./AssociateResourceCommand";
|
|
1
2
|
export * from "./CreateCanaryCommand";
|
|
3
|
+
export * from "./CreateGroupCommand";
|
|
2
4
|
export * from "./DeleteCanaryCommand";
|
|
5
|
+
export * from "./DeleteGroupCommand";
|
|
3
6
|
export * from "./DescribeCanariesCommand";
|
|
4
7
|
export * from "./DescribeCanariesLastRunCommand";
|
|
5
8
|
export * from "./DescribeRuntimeVersionsCommand";
|
|
9
|
+
export * from "./DisassociateResourceCommand";
|
|
6
10
|
export * from "./GetCanaryCommand";
|
|
7
11
|
export * from "./GetCanaryRunsCommand";
|
|
12
|
+
export * from "./GetGroupCommand";
|
|
13
|
+
export * from "./ListAssociatedGroupsCommand";
|
|
14
|
+
export * from "./ListGroupResourcesCommand";
|
|
15
|
+
export * from "./ListGroupsCommand";
|
|
8
16
|
export * from "./ListTagsForResourceCommand";
|
|
9
17
|
export * from "./StartCanaryCommand";
|
|
10
18
|
export * from "./StopCanaryCommand";
|
|
@@ -71,6 +71,103 @@ export declare namespace ArtifactConfigOutput {
|
|
|
71
71
|
*/
|
|
72
72
|
const filterSensitiveLog: (obj: ArtifactConfigOutput) => any;
|
|
73
73
|
}
|
|
74
|
+
export interface AssociateResourceRequest {
|
|
75
|
+
/**
|
|
76
|
+
* <p>Specifies the group. You can specify the group name, the ARN, or the
|
|
77
|
+
* group ID as the <code>GroupIdentifier</code>.</p>
|
|
78
|
+
*/
|
|
79
|
+
GroupIdentifier: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <p>The ARN of the canary that you want to associate with the specified group.</p>
|
|
82
|
+
*/
|
|
83
|
+
ResourceArn: string | undefined;
|
|
84
|
+
}
|
|
85
|
+
export declare namespace AssociateResourceRequest {
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
const filterSensitiveLog: (obj: AssociateResourceRequest) => any;
|
|
90
|
+
}
|
|
91
|
+
export interface AssociateResourceResponse {
|
|
92
|
+
}
|
|
93
|
+
export declare namespace AssociateResourceResponse {
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
const filterSensitiveLog: (obj: AssociateResourceResponse) => any;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* <p>A conflicting operation is already in progress.</p>
|
|
101
|
+
*/
|
|
102
|
+
export declare class ConflictException extends __BaseException {
|
|
103
|
+
readonly name: "ConflictException";
|
|
104
|
+
readonly $fault: "client";
|
|
105
|
+
Message?: string;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* <p>An unknown internal error occurred.</p>
|
|
113
|
+
*/
|
|
114
|
+
export declare class InternalServerException extends __BaseException {
|
|
115
|
+
readonly name: "InternalServerException";
|
|
116
|
+
readonly $fault: "server";
|
|
117
|
+
Message?: string;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* <p>One of the specified resources was not found.</p>
|
|
125
|
+
*/
|
|
126
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
127
|
+
readonly name: "ResourceNotFoundException";
|
|
128
|
+
readonly $fault: "client";
|
|
129
|
+
Message?: string;
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
133
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* <p>The request exceeded a service quota value.</p>
|
|
137
|
+
*/
|
|
138
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
139
|
+
readonly name: "ServiceQuotaExceededException";
|
|
140
|
+
readonly $fault: "client";
|
|
141
|
+
Message?: string;
|
|
142
|
+
/**
|
|
143
|
+
* @internal
|
|
144
|
+
*/
|
|
145
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* <p>A parameter could not be validated.</p>
|
|
149
|
+
*/
|
|
150
|
+
export declare class ValidationException extends __BaseException {
|
|
151
|
+
readonly name: "ValidationException";
|
|
152
|
+
readonly $fault: "client";
|
|
153
|
+
Message?: string;
|
|
154
|
+
/**
|
|
155
|
+
* @internal
|
|
156
|
+
*/
|
|
157
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* <p>The request was not valid.</p>
|
|
161
|
+
*/
|
|
162
|
+
export declare class BadRequestException extends __BaseException {
|
|
163
|
+
readonly name: "BadRequestException";
|
|
164
|
+
readonly $fault: "client";
|
|
165
|
+
Message?: string;
|
|
166
|
+
/**
|
|
167
|
+
* @internal
|
|
168
|
+
*/
|
|
169
|
+
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
170
|
+
}
|
|
74
171
|
/**
|
|
75
172
|
* <p>A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.</p>
|
|
76
173
|
*/
|
|
@@ -81,8 +178,12 @@ export interface BaseScreenshot {
|
|
|
81
178
|
*/
|
|
82
179
|
ScreenshotName: string | undefined;
|
|
83
180
|
/**
|
|
84
|
-
* <p>Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
|
|
85
|
-
*
|
|
181
|
+
* <p>Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
|
|
182
|
+
* coordinates to use here, use the
|
|
183
|
+
* CloudWatch console to draw the boundaries on the screen. For more information, see
|
|
184
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html">
|
|
185
|
+
* Editing or deleting a canary</a>
|
|
186
|
+
* </p>
|
|
86
187
|
*/
|
|
87
188
|
IgnoreCoordinates?: string[];
|
|
88
189
|
}
|
|
@@ -257,7 +358,8 @@ export interface VisualReferenceOutput {
|
|
|
257
358
|
*/
|
|
258
359
|
BaseScreenshots?: BaseScreenshot[];
|
|
259
360
|
/**
|
|
260
|
-
* <p>The ID of the canary run that produced the
|
|
361
|
+
* <p>The ID of the canary run that produced the baseline screenshots
|
|
362
|
+
* that are used for visual monitoring comparisons by this canary.</p>
|
|
261
363
|
*/
|
|
262
364
|
BaseCanaryRunId?: string;
|
|
263
365
|
}
|
|
@@ -576,6 +678,10 @@ export interface CanaryRunConfigInput {
|
|
|
576
678
|
* reserved environment variables as the keys for your environment variables. For
|
|
577
679
|
* more information about reserved keys, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime">
|
|
578
680
|
* Runtime environment variables</a>.</p>
|
|
681
|
+
* <important>
|
|
682
|
+
* <p>The environment variables keys and values are not encrypted. Do not store sensitive information
|
|
683
|
+
* in this field.</p>
|
|
684
|
+
* </important>
|
|
579
685
|
*/
|
|
580
686
|
EnvironmentVariables?: Record<string, string>;
|
|
581
687
|
}
|
|
@@ -620,18 +726,6 @@ export declare namespace CanaryScheduleInput {
|
|
|
620
726
|
*/
|
|
621
727
|
const filterSensitiveLog: (obj: CanaryScheduleInput) => any;
|
|
622
728
|
}
|
|
623
|
-
/**
|
|
624
|
-
* <p>A conflicting operation is already in progress.</p>
|
|
625
|
-
*/
|
|
626
|
-
export declare class ConflictException extends __BaseException {
|
|
627
|
-
readonly name: "ConflictException";
|
|
628
|
-
readonly $fault: "client";
|
|
629
|
-
Message?: string;
|
|
630
|
-
/**
|
|
631
|
-
* @internal
|
|
632
|
-
*/
|
|
633
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
634
|
-
}
|
|
635
729
|
/**
|
|
636
730
|
* <p>If this canary is to test an endpoint in a VPC, this structure contains
|
|
637
731
|
* information about the subnets and security groups of the VPC endpoint.
|
|
@@ -727,7 +821,11 @@ export interface CreateCanaryRequest {
|
|
|
727
821
|
Schedule: CanaryScheduleInput | undefined;
|
|
728
822
|
/**
|
|
729
823
|
* <p>A structure that contains the configuration for individual canary runs,
|
|
730
|
-
* such as timeout value.</p>
|
|
824
|
+
* such as timeout value and environment variables.</p>
|
|
825
|
+
* <important>
|
|
826
|
+
* <p>The environment variables keys and values are not encrypted. Do not store sensitive information
|
|
827
|
+
* in this field.</p>
|
|
828
|
+
* </important>
|
|
731
829
|
*/
|
|
732
830
|
RunConfig?: CanaryRunConfigInput;
|
|
733
831
|
/**
|
|
@@ -787,18 +885,6 @@ export declare namespace CreateCanaryResponse {
|
|
|
787
885
|
*/
|
|
788
886
|
const filterSensitiveLog: (obj: CreateCanaryResponse) => any;
|
|
789
887
|
}
|
|
790
|
-
/**
|
|
791
|
-
* <p>An unknown internal error occurred.</p>
|
|
792
|
-
*/
|
|
793
|
-
export declare class InternalServerException extends __BaseException {
|
|
794
|
-
readonly name: "InternalServerException";
|
|
795
|
-
readonly $fault: "server";
|
|
796
|
-
Message?: string;
|
|
797
|
-
/**
|
|
798
|
-
* @internal
|
|
799
|
-
*/
|
|
800
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
801
|
-
}
|
|
802
888
|
/**
|
|
803
889
|
* <p>One of the input resources is larger than is allowed.</p>
|
|
804
890
|
*/
|
|
@@ -811,17 +897,74 @@ export declare class RequestEntityTooLargeException extends __BaseException {
|
|
|
811
897
|
*/
|
|
812
898
|
constructor(opts: __ExceptionOptionType<RequestEntityTooLargeException, __BaseException>);
|
|
813
899
|
}
|
|
900
|
+
export interface CreateGroupRequest {
|
|
901
|
+
/**
|
|
902
|
+
* <p>The name for the group. It can include any Unicode characters.</p>
|
|
903
|
+
* <p>The names for all groups in your account, across all Regions, must be unique.</p>
|
|
904
|
+
*/
|
|
905
|
+
Name: string | undefined;
|
|
906
|
+
/**
|
|
907
|
+
* <p>A list of key-value pairs to associate with the group.
|
|
908
|
+
* You can associate as many as 50 tags with a group.</p>
|
|
909
|
+
* <p>Tags can help you organize and categorize your
|
|
910
|
+
* resources. You can also use them to scope user permissions, by
|
|
911
|
+
* granting a user permission to access or change only the resources that have
|
|
912
|
+
* certain tag values.</p>
|
|
913
|
+
*/
|
|
914
|
+
Tags?: Record<string, string>;
|
|
915
|
+
}
|
|
916
|
+
export declare namespace CreateGroupRequest {
|
|
917
|
+
/**
|
|
918
|
+
* @internal
|
|
919
|
+
*/
|
|
920
|
+
const filterSensitiveLog: (obj: CreateGroupRequest) => any;
|
|
921
|
+
}
|
|
814
922
|
/**
|
|
815
|
-
* <p>
|
|
923
|
+
* <p>This structure contains information about one group.</p>
|
|
816
924
|
*/
|
|
817
|
-
export
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
925
|
+
export interface Group {
|
|
926
|
+
/**
|
|
927
|
+
* <p>The unique ID of the group.</p>
|
|
928
|
+
*/
|
|
929
|
+
Id?: string;
|
|
930
|
+
/**
|
|
931
|
+
* <p>The name of the group.</p>
|
|
932
|
+
*/
|
|
933
|
+
Name?: string;
|
|
934
|
+
/**
|
|
935
|
+
* <p>The ARN of the group.</p>
|
|
936
|
+
*/
|
|
937
|
+
Arn?: string;
|
|
938
|
+
/**
|
|
939
|
+
* <p>The list of key-value pairs that are associated with the canary.</p>
|
|
940
|
+
*/
|
|
941
|
+
Tags?: Record<string, string>;
|
|
942
|
+
/**
|
|
943
|
+
* <p>The date and time that the group was created.</p>
|
|
944
|
+
*/
|
|
945
|
+
CreatedTime?: Date;
|
|
946
|
+
/**
|
|
947
|
+
* <p>The date and time that the group was most recently updated.</p>
|
|
948
|
+
*/
|
|
949
|
+
LastModifiedTime?: Date;
|
|
950
|
+
}
|
|
951
|
+
export declare namespace Group {
|
|
821
952
|
/**
|
|
822
953
|
* @internal
|
|
823
954
|
*/
|
|
824
|
-
|
|
955
|
+
const filterSensitiveLog: (obj: Group) => any;
|
|
956
|
+
}
|
|
957
|
+
export interface CreateGroupResponse {
|
|
958
|
+
/**
|
|
959
|
+
* <p>A structure that contains information about the group that was just created.</p>
|
|
960
|
+
*/
|
|
961
|
+
Group?: Group;
|
|
962
|
+
}
|
|
963
|
+
export declare namespace CreateGroupResponse {
|
|
964
|
+
/**
|
|
965
|
+
* @internal
|
|
966
|
+
*/
|
|
967
|
+
const filterSensitiveLog: (obj: CreateGroupResponse) => any;
|
|
825
968
|
}
|
|
826
969
|
export interface DeleteCanaryRequest {
|
|
827
970
|
/**
|
|
@@ -849,17 +992,26 @@ export declare namespace DeleteCanaryResponse {
|
|
|
849
992
|
*/
|
|
850
993
|
const filterSensitiveLog: (obj: DeleteCanaryResponse) => any;
|
|
851
994
|
}
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
995
|
+
export interface DeleteGroupRequest {
|
|
996
|
+
/**
|
|
997
|
+
* <p>Specifies which group to delete. You can specify the group name, the ARN, or the
|
|
998
|
+
* group ID as the <code>GroupIdentifier</code>.</p>
|
|
999
|
+
*/
|
|
1000
|
+
GroupIdentifier: string | undefined;
|
|
1001
|
+
}
|
|
1002
|
+
export declare namespace DeleteGroupRequest {
|
|
859
1003
|
/**
|
|
860
1004
|
* @internal
|
|
861
1005
|
*/
|
|
862
|
-
|
|
1006
|
+
const filterSensitiveLog: (obj: DeleteGroupRequest) => any;
|
|
1007
|
+
}
|
|
1008
|
+
export interface DeleteGroupResponse {
|
|
1009
|
+
}
|
|
1010
|
+
export declare namespace DeleteGroupResponse {
|
|
1011
|
+
/**
|
|
1012
|
+
* @internal
|
|
1013
|
+
*/
|
|
1014
|
+
const filterSensitiveLog: (obj: DeleteGroupResponse) => any;
|
|
863
1015
|
}
|
|
864
1016
|
export interface DescribeCanariesRequest {
|
|
865
1017
|
/**
|
|
@@ -914,7 +1066,7 @@ export declare namespace DescribeCanariesResponse {
|
|
|
914
1066
|
export interface DescribeCanariesLastRunRequest {
|
|
915
1067
|
/**
|
|
916
1068
|
* <p>A token that indicates that there is more data
|
|
917
|
-
* available. You can use this token in a subsequent <code>
|
|
1069
|
+
* available. You can use this token in a subsequent <code>DescribeCanariesLastRun</code> operation to retrieve the next
|
|
918
1070
|
* set of results.</p>
|
|
919
1071
|
*/
|
|
920
1072
|
NextToken?: string;
|
|
@@ -1030,6 +1182,31 @@ export declare namespace DescribeRuntimeVersionsResponse {
|
|
|
1030
1182
|
*/
|
|
1031
1183
|
const filterSensitiveLog: (obj: DescribeRuntimeVersionsResponse) => any;
|
|
1032
1184
|
}
|
|
1185
|
+
export interface DisassociateResourceRequest {
|
|
1186
|
+
/**
|
|
1187
|
+
* <p>Specifies the group. You can specify the group name, the ARN, or the
|
|
1188
|
+
* group ID as the <code>GroupIdentifier</code>.</p>
|
|
1189
|
+
*/
|
|
1190
|
+
GroupIdentifier: string | undefined;
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>The ARN of the canary that you want to remove from the specified group.</p>
|
|
1193
|
+
*/
|
|
1194
|
+
ResourceArn: string | undefined;
|
|
1195
|
+
}
|
|
1196
|
+
export declare namespace DisassociateResourceRequest {
|
|
1197
|
+
/**
|
|
1198
|
+
* @internal
|
|
1199
|
+
*/
|
|
1200
|
+
const filterSensitiveLog: (obj: DisassociateResourceRequest) => any;
|
|
1201
|
+
}
|
|
1202
|
+
export interface DisassociateResourceResponse {
|
|
1203
|
+
}
|
|
1204
|
+
export declare namespace DisassociateResourceResponse {
|
|
1205
|
+
/**
|
|
1206
|
+
* @internal
|
|
1207
|
+
*/
|
|
1208
|
+
const filterSensitiveLog: (obj: DisassociateResourceResponse) => any;
|
|
1209
|
+
}
|
|
1033
1210
|
export interface GetCanaryRequest {
|
|
1034
1211
|
/**
|
|
1035
1212
|
* <p>The name of the canary that you want details for.</p>
|
|
@@ -1044,7 +1221,7 @@ export declare namespace GetCanaryRequest {
|
|
|
1044
1221
|
}
|
|
1045
1222
|
export interface GetCanaryResponse {
|
|
1046
1223
|
/**
|
|
1047
|
-
* <p>A
|
|
1224
|
+
* <p>A structure that contains the full information about the canary.</p>
|
|
1048
1225
|
*/
|
|
1049
1226
|
Canary?: Canary;
|
|
1050
1227
|
}
|
|
@@ -1097,12 +1274,196 @@ export declare namespace GetCanaryRunsResponse {
|
|
|
1097
1274
|
*/
|
|
1098
1275
|
const filterSensitiveLog: (obj: GetCanaryRunsResponse) => any;
|
|
1099
1276
|
}
|
|
1277
|
+
export interface GetGroupRequest {
|
|
1278
|
+
/**
|
|
1279
|
+
* <p>Specifies the group to return information for. You can specify the group name, the ARN, or the
|
|
1280
|
+
* group ID as the <code>GroupIdentifier</code>.</p>
|
|
1281
|
+
*/
|
|
1282
|
+
GroupIdentifier: string | undefined;
|
|
1283
|
+
}
|
|
1284
|
+
export declare namespace GetGroupRequest {
|
|
1285
|
+
/**
|
|
1286
|
+
* @internal
|
|
1287
|
+
*/
|
|
1288
|
+
const filterSensitiveLog: (obj: GetGroupRequest) => any;
|
|
1289
|
+
}
|
|
1290
|
+
export interface GetGroupResponse {
|
|
1291
|
+
/**
|
|
1292
|
+
* <p>A structure that contains information about the group.</p>
|
|
1293
|
+
*/
|
|
1294
|
+
Group?: Group;
|
|
1295
|
+
}
|
|
1296
|
+
export declare namespace GetGroupResponse {
|
|
1297
|
+
/**
|
|
1298
|
+
* @internal
|
|
1299
|
+
*/
|
|
1300
|
+
const filterSensitiveLog: (obj: GetGroupResponse) => any;
|
|
1301
|
+
}
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>A structure containing some information about a group.</p>
|
|
1304
|
+
*/
|
|
1305
|
+
export interface GroupSummary {
|
|
1306
|
+
/**
|
|
1307
|
+
* <p>The unique ID of the group.</p>
|
|
1308
|
+
*/
|
|
1309
|
+
Id?: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>The name of the group.</p>
|
|
1312
|
+
*/
|
|
1313
|
+
Name?: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* <p>The ARN of the group.</p>
|
|
1316
|
+
*/
|
|
1317
|
+
Arn?: string;
|
|
1318
|
+
}
|
|
1319
|
+
export declare namespace GroupSummary {
|
|
1320
|
+
/**
|
|
1321
|
+
* @internal
|
|
1322
|
+
*/
|
|
1323
|
+
const filterSensitiveLog: (obj: GroupSummary) => any;
|
|
1324
|
+
}
|
|
1325
|
+
/**
|
|
1326
|
+
* <p>An internal failure occurred. Try the operation again.</p>
|
|
1327
|
+
*/
|
|
1328
|
+
export declare class InternalFailureException extends __BaseException {
|
|
1329
|
+
readonly name: "InternalFailureException";
|
|
1330
|
+
readonly $fault: "server";
|
|
1331
|
+
Message?: string;
|
|
1332
|
+
/**
|
|
1333
|
+
* @internal
|
|
1334
|
+
*/
|
|
1335
|
+
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
1336
|
+
}
|
|
1337
|
+
export interface ListAssociatedGroupsRequest {
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>A token that indicates that there is more data
|
|
1340
|
+
* available. You can use this token in a subsequent operation to retrieve the next
|
|
1341
|
+
* set of results.</p>
|
|
1342
|
+
*/
|
|
1343
|
+
NextToken?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>Specify this parameter to limit how many groups are returned each time you use
|
|
1346
|
+
* the <code>ListAssociatedGroups</code> operation. If you omit this parameter, the default of 20 is used.</p>
|
|
1347
|
+
*/
|
|
1348
|
+
MaxResults?: number;
|
|
1349
|
+
/**
|
|
1350
|
+
* <p>The ARN of the canary that you want to view groups for.</p>
|
|
1351
|
+
*/
|
|
1352
|
+
ResourceArn: string | undefined;
|
|
1353
|
+
}
|
|
1354
|
+
export declare namespace ListAssociatedGroupsRequest {
|
|
1355
|
+
/**
|
|
1356
|
+
* @internal
|
|
1357
|
+
*/
|
|
1358
|
+
const filterSensitiveLog: (obj: ListAssociatedGroupsRequest) => any;
|
|
1359
|
+
}
|
|
1360
|
+
export interface ListAssociatedGroupsResponse {
|
|
1361
|
+
/**
|
|
1362
|
+
* <p>An array of structures that contain information about the groups that this canary is associated with.</p>
|
|
1363
|
+
*/
|
|
1364
|
+
Groups?: GroupSummary[];
|
|
1365
|
+
/**
|
|
1366
|
+
* <p>A token that indicates that there is more data
|
|
1367
|
+
* available. You can use this token in a subsequent <code>ListAssociatedGroups</code> operation to retrieve the next
|
|
1368
|
+
* set of results.</p>
|
|
1369
|
+
*/
|
|
1370
|
+
NextToken?: string;
|
|
1371
|
+
}
|
|
1372
|
+
export declare namespace ListAssociatedGroupsResponse {
|
|
1373
|
+
/**
|
|
1374
|
+
* @internal
|
|
1375
|
+
*/
|
|
1376
|
+
const filterSensitiveLog: (obj: ListAssociatedGroupsResponse) => any;
|
|
1377
|
+
}
|
|
1378
|
+
export interface ListGroupResourcesRequest {
|
|
1379
|
+
/**
|
|
1380
|
+
* <p>A token that indicates that there is more data
|
|
1381
|
+
* available. You can use this token in a subsequent operation to retrieve the next
|
|
1382
|
+
* set of results.</p>
|
|
1383
|
+
*/
|
|
1384
|
+
NextToken?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>Specify this parameter to limit how many canary ARNs are returned each time you use
|
|
1387
|
+
* the <code>ListGroupResources</code> operation. If you omit this parameter, the default of 20 is used.</p>
|
|
1388
|
+
*/
|
|
1389
|
+
MaxResults?: number;
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>Specifies the group to return information for. You can specify the group name, the ARN, or the
|
|
1392
|
+
* group ID as the <code>GroupIdentifier</code>.</p>
|
|
1393
|
+
*/
|
|
1394
|
+
GroupIdentifier: string | undefined;
|
|
1395
|
+
}
|
|
1396
|
+
export declare namespace ListGroupResourcesRequest {
|
|
1397
|
+
/**
|
|
1398
|
+
* @internal
|
|
1399
|
+
*/
|
|
1400
|
+
const filterSensitiveLog: (obj: ListGroupResourcesRequest) => any;
|
|
1401
|
+
}
|
|
1402
|
+
export interface ListGroupResourcesResponse {
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>An array of ARNs. These ARNs are for the canaries that are associated with the group.</p>
|
|
1405
|
+
*/
|
|
1406
|
+
Resources?: string[];
|
|
1407
|
+
/**
|
|
1408
|
+
* <p>A token that indicates that there is more data
|
|
1409
|
+
* available. You can use this token in a subsequent <code>ListGroupResources</code> operation to retrieve the next
|
|
1410
|
+
* set of results.</p>
|
|
1411
|
+
*/
|
|
1412
|
+
NextToken?: string;
|
|
1413
|
+
}
|
|
1414
|
+
export declare namespace ListGroupResourcesResponse {
|
|
1415
|
+
/**
|
|
1416
|
+
* @internal
|
|
1417
|
+
*/
|
|
1418
|
+
const filterSensitiveLog: (obj: ListGroupResourcesResponse) => any;
|
|
1419
|
+
}
|
|
1420
|
+
export interface ListGroupsRequest {
|
|
1421
|
+
/**
|
|
1422
|
+
* <p>A token that indicates that there is more data
|
|
1423
|
+
* available. You can use this token in a subsequent operation to retrieve the next
|
|
1424
|
+
* set of results.</p>
|
|
1425
|
+
*/
|
|
1426
|
+
NextToken?: string;
|
|
1427
|
+
/**
|
|
1428
|
+
* <p>Specify this parameter to limit how many groups are returned each time you use
|
|
1429
|
+
* the <code>ListGroups</code> operation. If you omit this parameter, the default of 20 is used.</p>
|
|
1430
|
+
*/
|
|
1431
|
+
MaxResults?: number;
|
|
1432
|
+
}
|
|
1433
|
+
export declare namespace ListGroupsRequest {
|
|
1434
|
+
/**
|
|
1435
|
+
* @internal
|
|
1436
|
+
*/
|
|
1437
|
+
const filterSensitiveLog: (obj: ListGroupsRequest) => any;
|
|
1438
|
+
}
|
|
1439
|
+
export interface ListGroupsResponse {
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>An array of structures that each contain information about one group.</p>
|
|
1442
|
+
*/
|
|
1443
|
+
Groups?: GroupSummary[];
|
|
1444
|
+
/**
|
|
1445
|
+
* <p>A token that indicates that there is more data
|
|
1446
|
+
* available. You can use this token in a subsequent <code>ListGroups</code> operation to retrieve the next
|
|
1447
|
+
* set of results.</p>
|
|
1448
|
+
*/
|
|
1449
|
+
NextToken?: string;
|
|
1450
|
+
}
|
|
1451
|
+
export declare namespace ListGroupsResponse {
|
|
1452
|
+
/**
|
|
1453
|
+
* @internal
|
|
1454
|
+
*/
|
|
1455
|
+
const filterSensitiveLog: (obj: ListGroupsResponse) => any;
|
|
1456
|
+
}
|
|
1100
1457
|
export interface ListTagsForResourceRequest {
|
|
1101
1458
|
/**
|
|
1102
|
-
* <p>The ARN of the canary that you want to view tags for.</p>
|
|
1459
|
+
* <p>The ARN of the canary or group that you want to view tags for.</p>
|
|
1103
1460
|
* <p>The ARN format of a canary is
|
|
1104
1461
|
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
|
|
1105
1462
|
* </code>.</p>
|
|
1463
|
+
* <p>The ARN format of a group is
|
|
1464
|
+
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
|
|
1465
|
+
* </code>
|
|
1466
|
+
* </p>
|
|
1106
1467
|
*/
|
|
1107
1468
|
ResourceArn: string | undefined;
|
|
1108
1469
|
}
|
|
@@ -1114,7 +1475,7 @@ export declare namespace ListTagsForResourceRequest {
|
|
|
1114
1475
|
}
|
|
1115
1476
|
export interface ListTagsForResourceResponse {
|
|
1116
1477
|
/**
|
|
1117
|
-
* <p>The list of tag keys and values associated with the
|
|
1478
|
+
* <p>The list of tag keys and values associated with the resource that you specified.</p>
|
|
1118
1479
|
*/
|
|
1119
1480
|
Tags?: Record<string, string>;
|
|
1120
1481
|
}
|
|
@@ -1124,6 +1485,30 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
1124
1485
|
*/
|
|
1125
1486
|
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
1126
1487
|
}
|
|
1488
|
+
/**
|
|
1489
|
+
* <p>The specified resource was not found.</p>
|
|
1490
|
+
*/
|
|
1491
|
+
export declare class NotFoundException extends __BaseException {
|
|
1492
|
+
readonly name: "NotFoundException";
|
|
1493
|
+
readonly $fault: "client";
|
|
1494
|
+
Message?: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* @internal
|
|
1497
|
+
*/
|
|
1498
|
+
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
1499
|
+
}
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>There were too many simultaneous requests. Try the operation again.</p>
|
|
1502
|
+
*/
|
|
1503
|
+
export declare class TooManyRequestsException extends __BaseException {
|
|
1504
|
+
readonly name: "TooManyRequestsException";
|
|
1505
|
+
readonly $fault: "client";
|
|
1506
|
+
Message?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* @internal
|
|
1509
|
+
*/
|
|
1510
|
+
constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
|
|
1511
|
+
}
|
|
1127
1512
|
export interface StartCanaryRequest {
|
|
1128
1513
|
/**
|
|
1129
1514
|
* <p>The name of the canary that you want to run. To find
|
|
@@ -1148,7 +1533,7 @@ export declare namespace StartCanaryResponse {
|
|
|
1148
1533
|
export interface StopCanaryRequest {
|
|
1149
1534
|
/**
|
|
1150
1535
|
* <p>The name of the canary that you want to stop. To find the names of your
|
|
1151
|
-
* canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">
|
|
1536
|
+
* canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">ListCanaries</a>.</p>
|
|
1152
1537
|
*/
|
|
1153
1538
|
Name: string | undefined;
|
|
1154
1539
|
}
|
|
@@ -1168,14 +1553,18 @@ export declare namespace StopCanaryResponse {
|
|
|
1168
1553
|
}
|
|
1169
1554
|
export interface TagResourceRequest {
|
|
1170
1555
|
/**
|
|
1171
|
-
* <p>The ARN of the canary that you're adding tags to.</p>
|
|
1556
|
+
* <p>The ARN of the canary or group that you're adding tags to.</p>
|
|
1172
1557
|
* <p>The ARN format of a canary is
|
|
1173
|
-
*
|
|
1558
|
+
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
|
|
1174
1559
|
* </code>.</p>
|
|
1560
|
+
* <p>The ARN format of a group is
|
|
1561
|
+
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
|
|
1562
|
+
* </code>
|
|
1563
|
+
* </p>
|
|
1175
1564
|
*/
|
|
1176
1565
|
ResourceArn: string | undefined;
|
|
1177
1566
|
/**
|
|
1178
|
-
* <p>The list of key-value pairs to associate with the
|
|
1567
|
+
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
1179
1568
|
*/
|
|
1180
1569
|
Tags: Record<string, string> | undefined;
|
|
1181
1570
|
}
|
|
@@ -1195,10 +1584,14 @@ export declare namespace TagResourceResponse {
|
|
|
1195
1584
|
}
|
|
1196
1585
|
export interface UntagResourceRequest {
|
|
1197
1586
|
/**
|
|
1198
|
-
* <p>The ARN of the canary that you're removing tags from.</p>
|
|
1587
|
+
* <p>The ARN of the canary or group that you're removing tags from.</p>
|
|
1199
1588
|
* <p>The ARN format of a canary is
|
|
1200
1589
|
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
|
|
1201
1590
|
* </code>.</p>
|
|
1591
|
+
* <p>The ARN format of a group is
|
|
1592
|
+
* <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
|
|
1593
|
+
* </code>
|
|
1594
|
+
* </p>
|
|
1202
1595
|
*/
|
|
1203
1596
|
ResourceArn: string | undefined;
|
|
1204
1597
|
/**
|
|
@@ -1221,7 +1614,8 @@ export declare namespace UntagResourceResponse {
|
|
|
1221
1614
|
const filterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
1222
1615
|
}
|
|
1223
1616
|
/**
|
|
1224
|
-
* <p>An object that specifies what screenshots to use as a baseline for visual monitoring by this canary
|
|
1617
|
+
* <p>An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can
|
|
1618
|
+
* optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.</p>
|
|
1225
1619
|
*
|
|
1226
1620
|
* <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b>
|
|
1227
1621
|
* runtime or later. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html">
|
|
@@ -1321,6 +1715,10 @@ export interface UpdateCanaryRequest {
|
|
|
1321
1715
|
/**
|
|
1322
1716
|
* <p>A structure that contains the timeout value that is used for each individual run of the
|
|
1323
1717
|
* canary.</p>
|
|
1718
|
+
* <important>
|
|
1719
|
+
* <p>The environment variables keys and values are not encrypted. Do not store sensitive information
|
|
1720
|
+
* in this field.</p>
|
|
1721
|
+
* </important>
|
|
1324
1722
|
*/
|
|
1325
1723
|
RunConfig?: CanaryRunConfigInput;
|
|
1326
1724
|
/**
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput } from "../commands/ListAssociatedGroupsCommand";
|
|
3
|
+
import { SyntheticsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListAssociatedGroups(config: SyntheticsPaginationConfiguration, input: ListAssociatedGroupsCommandInput, ...additionalArguments: any): Paginator<ListAssociatedGroupsCommandOutput>;
|