@aws-sdk/client-synthetics 3.872.0 → 3.874.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/dist-cjs/index.js CHANGED
@@ -24,6 +24,7 @@ __export(index_exports, {
24
24
  AccessDeniedException: () => AccessDeniedException,
25
25
  AssociateResourceCommand: () => AssociateResourceCommand,
26
26
  BadRequestException: () => BadRequestException,
27
+ BrowserType: () => BrowserType,
27
28
  CanaryRunState: () => CanaryRunState,
28
29
  CanaryRunStateReasonCode: () => CanaryRunStateReasonCode,
29
30
  CanaryRunTestResult: () => CanaryRunTestResult,
@@ -392,6 +393,10 @@ var BadRequestException = class _BadRequestException extends SyntheticsServiceEx
392
393
  this.Message = opts.Message;
393
394
  }
394
395
  };
396
+ var BrowserType = {
397
+ CHROME: "CHROME",
398
+ FIREFOX: "FIREFOX"
399
+ };
395
400
  var DependencyType = {
396
401
  LambdaLayer: "LambdaLayer"
397
402
  };
@@ -554,6 +559,7 @@ var se_CreateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
554
559
  (0, import_smithy_client.take)(input, {
555
560
  ArtifactConfig: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "ArtifactConfig"),
556
561
  ArtifactS3Location: [],
562
+ BrowserConfigs: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "BrowserConfigs"),
557
563
  Code: /* @__PURE__ */ __name((_) => se_CanaryCodeInput(_, context), "Code"),
558
564
  ExecutionRoleArn: [],
559
565
  FailureRetentionPeriodInDays: [],
@@ -634,6 +640,7 @@ var se_DescribeCanariesLastRunCommand = /* @__PURE__ */ __name(async (input, con
634
640
  let body;
635
641
  body = JSON.stringify(
636
642
  (0, import_smithy_client.take)(input, {
643
+ BrowserType: [],
637
644
  MaxResults: [],
638
645
  Names: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "Names"),
639
646
  NextToken: []
@@ -794,6 +801,7 @@ var se_StartCanaryDryRunCommand = /* @__PURE__ */ __name(async (input, context)
794
801
  (0, import_smithy_client.take)(input, {
795
802
  ArtifactConfig: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "ArtifactConfig"),
796
803
  ArtifactS3Location: [],
804
+ BrowserConfigs: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "BrowserConfigs"),
797
805
  Code: /* @__PURE__ */ __name((_) => se_CanaryCodeInput(_, context), "Code"),
798
806
  ExecutionRoleArn: [],
799
807
  FailureRetentionPeriodInDays: [],
@@ -802,6 +810,7 @@ var se_StartCanaryDryRunCommand = /* @__PURE__ */ __name(async (input, context)
802
810
  RuntimeVersion: [],
803
811
  SuccessRetentionPeriodInDays: [],
804
812
  VisualReference: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VisualReference"),
813
+ VisualReferences: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VisualReferences"),
805
814
  VpcConfig: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VpcConfig")
806
815
  })
807
816
  );
@@ -857,6 +866,7 @@ var se_UpdateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
857
866
  (0, import_smithy_client.take)(input, {
858
867
  ArtifactConfig: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "ArtifactConfig"),
859
868
  ArtifactS3Location: [],
869
+ BrowserConfigs: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "BrowserConfigs"),
860
870
  Code: /* @__PURE__ */ __name((_) => se_CanaryCodeInput(_, context), "Code"),
861
871
  DryRunId: [],
862
872
  ExecutionRoleArn: [],
@@ -867,6 +877,7 @@ var se_UpdateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
867
877
  Schedule: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "Schedule"),
868
878
  SuccessRetentionPeriodInDays: [],
869
879
  VisualReference: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VisualReference"),
880
+ VisualReferences: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VisualReferences"),
870
881
  VpcConfig: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "VpcConfig")
871
882
  })
872
883
  );
@@ -1371,9 +1382,11 @@ var de_Canary = /* @__PURE__ */ __name((output, context) => {
1371
1382
  return (0, import_smithy_client.take)(output, {
1372
1383
  ArtifactConfig: import_smithy_client._json,
1373
1384
  ArtifactS3Location: import_smithy_client.expectString,
1385
+ BrowserConfigs: import_smithy_client._json,
1374
1386
  Code: import_smithy_client._json,
1375
1387
  DryRunConfig: import_smithy_client._json,
1376
1388
  EngineArn: import_smithy_client.expectString,
1389
+ EngineConfigs: import_smithy_client._json,
1377
1390
  ExecutionRoleArn: import_smithy_client.expectString,
1378
1391
  FailureRetentionPeriodInDays: import_smithy_client.expectInt32,
1379
1392
  Id: import_smithy_client.expectString,
@@ -1387,6 +1400,7 @@ var de_Canary = /* @__PURE__ */ __name((output, context) => {
1387
1400
  Tags: import_smithy_client._json,
1388
1401
  Timeline: /* @__PURE__ */ __name((_) => de_CanaryTimeline(_, context), "Timeline"),
1389
1402
  VisualReference: import_smithy_client._json,
1403
+ VisualReferences: import_smithy_client._json,
1390
1404
  VpcConfig: import_smithy_client._json
1391
1405
  });
1392
1406
  }, "de_Canary");
@@ -1399,6 +1413,7 @@ var de_CanaryLastRun = /* @__PURE__ */ __name((output, context) => {
1399
1413
  var de_CanaryRun = /* @__PURE__ */ __name((output, context) => {
1400
1414
  return (0, import_smithy_client.take)(output, {
1401
1415
  ArtifactS3Location: import_smithy_client.expectString,
1416
+ BrowserType: import_smithy_client.expectString,
1402
1417
  DryRunConfig: import_smithy_client._json,
1403
1418
  Id: import_smithy_client.expectString,
1404
1419
  Name: import_smithy_client.expectString,
@@ -1897,6 +1912,7 @@ var paginateListGroups = (0, import_core.createPaginator)(SyntheticsClient, List
1897
1912
  ServiceQuotaExceededException,
1898
1913
  ValidationException,
1899
1914
  BadRequestException,
1915
+ BrowserType,
1900
1916
  DependencyType,
1901
1917
  ProvisionedResourceCleanupSetting,
1902
1918
  CanaryState,
@@ -101,6 +101,10 @@ export class BadRequestException extends __BaseException {
101
101
  this.Message = opts.Message;
102
102
  }
103
103
  }
104
+ export const BrowserType = {
105
+ CHROME: "CHROME",
106
+ FIREFOX: "FIREFOX",
107
+ };
104
108
  export const DependencyType = {
105
109
  LambdaLayer: "LambdaLayer",
106
110
  };
@@ -27,6 +27,7 @@ export const se_CreateCanaryCommand = async (input, context) => {
27
27
  body = JSON.stringify(take(input, {
28
28
  ArtifactConfig: (_) => _json(_),
29
29
  ArtifactS3Location: [],
30
+ BrowserConfigs: (_) => _json(_),
30
31
  Code: (_) => se_CanaryCodeInput(_, context),
31
32
  ExecutionRoleArn: [],
32
33
  FailureRetentionPeriodInDays: [],
@@ -101,6 +102,7 @@ export const se_DescribeCanariesLastRunCommand = async (input, context) => {
101
102
  b.bp("/canaries/last-run");
102
103
  let body;
103
104
  body = JSON.stringify(take(input, {
105
+ BrowserType: [],
104
106
  MaxResults: [],
105
107
  Names: (_) => _json(_),
106
108
  NextToken: [],
@@ -247,6 +249,7 @@ export const se_StartCanaryDryRunCommand = async (input, context) => {
247
249
  body = JSON.stringify(take(input, {
248
250
  ArtifactConfig: (_) => _json(_),
249
251
  ArtifactS3Location: [],
252
+ BrowserConfigs: (_) => _json(_),
250
253
  Code: (_) => se_CanaryCodeInput(_, context),
251
254
  ExecutionRoleArn: [],
252
255
  FailureRetentionPeriodInDays: [],
@@ -255,6 +258,7 @@ export const se_StartCanaryDryRunCommand = async (input, context) => {
255
258
  RuntimeVersion: [],
256
259
  SuccessRetentionPeriodInDays: [],
257
260
  VisualReference: (_) => _json(_),
261
+ VisualReferences: (_) => _json(_),
258
262
  VpcConfig: (_) => _json(_),
259
263
  }));
260
264
  b.m("POST").h(headers).b(body);
@@ -306,6 +310,7 @@ export const se_UpdateCanaryCommand = async (input, context) => {
306
310
  body = JSON.stringify(take(input, {
307
311
  ArtifactConfig: (_) => _json(_),
308
312
  ArtifactS3Location: [],
313
+ BrowserConfigs: (_) => _json(_),
309
314
  Code: (_) => se_CanaryCodeInput(_, context),
310
315
  DryRunId: [],
311
316
  ExecutionRoleArn: [],
@@ -316,6 +321,7 @@ export const se_UpdateCanaryCommand = async (input, context) => {
316
321
  Schedule: (_) => _json(_),
317
322
  SuccessRetentionPeriodInDays: [],
318
323
  VisualReference: (_) => _json(_),
324
+ VisualReferences: (_) => _json(_),
319
325
  VpcConfig: (_) => _json(_),
320
326
  }));
321
327
  b.m("PATCH").h(headers).b(body);
@@ -823,9 +829,11 @@ const de_Canary = (output, context) => {
823
829
  return take(output, {
824
830
  ArtifactConfig: _json,
825
831
  ArtifactS3Location: __expectString,
832
+ BrowserConfigs: _json,
826
833
  Code: _json,
827
834
  DryRunConfig: _json,
828
835
  EngineArn: __expectString,
836
+ EngineConfigs: _json,
829
837
  ExecutionRoleArn: __expectString,
830
838
  FailureRetentionPeriodInDays: __expectInt32,
831
839
  Id: __expectString,
@@ -839,6 +847,7 @@ const de_Canary = (output, context) => {
839
847
  Tags: _json,
840
848
  Timeline: (_) => de_CanaryTimeline(_, context),
841
849
  VisualReference: _json,
850
+ VisualReferences: _json,
842
851
  VpcConfig: _json,
843
852
  });
844
853
  };
@@ -851,6 +860,7 @@ const de_CanaryLastRun = (output, context) => {
851
860
  const de_CanaryRun = (output, context) => {
852
861
  return take(output, {
853
862
  ArtifactS3Location: __expectString,
863
+ BrowserType: __expectString,
854
864
  DryRunConfig: _json,
855
865
  Id: __expectString,
856
866
  Name: __expectString,
@@ -96,6 +96,11 @@ declare const CreateCanaryCommand_base: {
96
96
  * "lambda-function",
97
97
  * ],
98
98
  * ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
99
+ * BrowserConfigs: [ // BrowserConfigs
100
+ * { // BrowserConfig
101
+ * BrowserType: "CHROME" || "FIREFOX",
102
+ * },
103
+ * ],
99
104
  * Tags: { // TagMap
100
105
  * "<keys>": "STRING_VALUE",
101
106
  * },
@@ -172,8 +177,34 @@ declare const CreateCanaryCommand_base: {
172
177
  * // },
173
178
  * // ],
174
179
  * // BaseCanaryRunId: "STRING_VALUE",
180
+ * // BrowserType: "CHROME" || "FIREFOX",
175
181
  * // },
176
182
  * // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
183
+ * // BrowserConfigs: [ // BrowserConfigs
184
+ * // { // BrowserConfig
185
+ * // BrowserType: "CHROME" || "FIREFOX",
186
+ * // },
187
+ * // ],
188
+ * // EngineConfigs: [ // EngineConfigs
189
+ * // { // EngineConfig
190
+ * // EngineArn: "STRING_VALUE",
191
+ * // BrowserType: "CHROME" || "FIREFOX",
192
+ * // },
193
+ * // ],
194
+ * // VisualReferences: [ // VisualReferencesOutput
195
+ * // {
196
+ * // BaseScreenshots: [
197
+ * // {
198
+ * // ScreenshotName: "STRING_VALUE", // required
199
+ * // IgnoreCoordinates: [
200
+ * // "STRING_VALUE",
201
+ * // ],
202
+ * // },
203
+ * // ],
204
+ * // BaseCanaryRunId: "STRING_VALUE",
205
+ * // BrowserType: "CHROME" || "FIREFOX",
206
+ * // },
207
+ * // ],
177
208
  * // Tags: { // TagMap
178
209
  * // "<keys>": "STRING_VALUE",
179
210
  * // },
@@ -117,8 +117,34 @@ declare const DescribeCanariesCommand_base: {
117
117
  * // },
118
118
  * // ],
119
119
  * // BaseCanaryRunId: "STRING_VALUE",
120
+ * // BrowserType: "CHROME" || "FIREFOX",
120
121
  * // },
121
122
  * // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
123
+ * // BrowserConfigs: [ // BrowserConfigs
124
+ * // { // BrowserConfig
125
+ * // BrowserType: "CHROME" || "FIREFOX",
126
+ * // },
127
+ * // ],
128
+ * // EngineConfigs: [ // EngineConfigs
129
+ * // { // EngineConfig
130
+ * // EngineArn: "STRING_VALUE",
131
+ * // BrowserType: "CHROME" || "FIREFOX",
132
+ * // },
133
+ * // ],
134
+ * // VisualReferences: [ // VisualReferencesOutput
135
+ * // {
136
+ * // BaseScreenshots: [
137
+ * // {
138
+ * // ScreenshotName: "STRING_VALUE", // required
139
+ * // IgnoreCoordinates: [
140
+ * // "STRING_VALUE",
141
+ * // ],
142
+ * // },
143
+ * // ],
144
+ * // BaseCanaryRunId: "STRING_VALUE",
145
+ * // BrowserType: "CHROME" || "FIREFOX",
146
+ * // },
147
+ * // ],
122
148
  * // Tags: { // TagMap
123
149
  * // "<keys>": "STRING_VALUE",
124
150
  * // },
@@ -48,6 +48,7 @@ declare const DescribeCanariesLastRunCommand_base: {
48
48
  * Names: [ // DescribeCanariesLastRunNameFilter
49
49
  * "STRING_VALUE",
50
50
  * ],
51
+ * BrowserType: "CHROME" || "FIREFOX",
51
52
  * };
52
53
  * const command = new DescribeCanariesLastRunCommand(input);
53
54
  * const response = await client.send(command);
@@ -75,6 +76,7 @@ declare const DescribeCanariesLastRunCommand_base: {
75
76
  * // DryRunConfig: { // CanaryDryRunConfigOutput
76
77
  * // DryRunId: "STRING_VALUE",
77
78
  * // },
79
+ * // BrowserType: "CHROME" || "FIREFOX",
78
80
  * // },
79
81
  * // },
80
82
  * // ],
@@ -106,8 +106,34 @@ declare const GetCanaryCommand_base: {
106
106
  * // },
107
107
  * // ],
108
108
  * // BaseCanaryRunId: "STRING_VALUE",
109
+ * // BrowserType: "CHROME" || "FIREFOX",
109
110
  * // },
110
111
  * // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
112
+ * // BrowserConfigs: [ // BrowserConfigs
113
+ * // { // BrowserConfig
114
+ * // BrowserType: "CHROME" || "FIREFOX",
115
+ * // },
116
+ * // ],
117
+ * // EngineConfigs: [ // EngineConfigs
118
+ * // { // EngineConfig
119
+ * // EngineArn: "STRING_VALUE",
120
+ * // BrowserType: "CHROME" || "FIREFOX",
121
+ * // },
122
+ * // ],
123
+ * // VisualReferences: [ // VisualReferencesOutput
124
+ * // {
125
+ * // BaseScreenshots: [
126
+ * // {
127
+ * // ScreenshotName: "STRING_VALUE", // required
128
+ * // IgnoreCoordinates: [
129
+ * // "STRING_VALUE",
130
+ * // ],
131
+ * // },
132
+ * // ],
133
+ * // BaseCanaryRunId: "STRING_VALUE",
134
+ * // BrowserType: "CHROME" || "FIREFOX",
135
+ * // },
136
+ * // ],
111
137
  * // Tags: { // TagMap
112
138
  * // "<keys>": "STRING_VALUE",
113
139
  * // },
@@ -65,6 +65,7 @@ declare const GetCanaryRunsCommand_base: {
65
65
  * // DryRunConfig: { // CanaryDryRunConfigOutput
66
66
  * // DryRunId: "STRING_VALUE",
67
67
  * // },
68
+ * // BrowserType: "CHROME" || "FIREFOX",
68
69
  * // },
69
70
  * // ],
70
71
  * // NextToken: "STRING_VALUE",
@@ -81,6 +81,7 @@ declare const StartCanaryDryRunCommand_base: {
81
81
  * },
82
82
  * ],
83
83
  * BaseCanaryRunId: "STRING_VALUE", // required
84
+ * BrowserType: "CHROME" || "FIREFOX",
84
85
  * },
85
86
  * ArtifactS3Location: "STRING_VALUE",
86
87
  * ArtifactConfig: { // ArtifactConfigInput
@@ -90,6 +91,25 @@ declare const StartCanaryDryRunCommand_base: {
90
91
  * },
91
92
  * },
92
93
  * ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
94
+ * BrowserConfigs: [ // BrowserConfigs
95
+ * { // BrowserConfig
96
+ * BrowserType: "CHROME" || "FIREFOX",
97
+ * },
98
+ * ],
99
+ * VisualReferences: [ // VisualReferences
100
+ * {
101
+ * BaseScreenshots: [
102
+ * {
103
+ * ScreenshotName: "STRING_VALUE", // required
104
+ * IgnoreCoordinates: [
105
+ * "STRING_VALUE",
106
+ * ],
107
+ * },
108
+ * ],
109
+ * BaseCanaryRunId: "STRING_VALUE", // required
110
+ * BrowserType: "CHROME" || "FIREFOX",
111
+ * },
112
+ * ],
93
113
  * };
94
114
  * const command = new StartCanaryDryRunCommand(input);
95
115
  * const response = await client.send(command);
@@ -27,10 +27,17 @@ declare const UpdateCanaryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the configuration of a canary that has
31
- * already been created.</p>
32
- * <p>You can't use this operation to update the tags of an existing canary. To
33
- * change the tags of an existing canary, use
30
+ * <p>Updates the configuration of a canary that has already been created.</p>
31
+ * <p>For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example:</p>
32
+ * <ul>
33
+ * <li>
34
+ * <p>To add Firefox to a canary that currently uses Chrome, specify browserConfigs as [CHROME, FIREFOX]</p>
35
+ * </li>
36
+ * <li>
37
+ * <p>To remove Firefox and keep only Chrome, specify browserConfigs as [CHROME]</p>
38
+ * </li>
39
+ * </ul>
40
+ * <p>You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use
34
41
  * <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
35
42
  * <note>
36
43
  * <p>When you use the <code>dryRunId</code> field when updating a canary, the only other field you can provide is the <code>Schedule</code>. Adding any other field will thrown an exception.</p>
@@ -95,6 +102,7 @@ declare const UpdateCanaryCommand_base: {
95
102
  * },
96
103
  * ],
97
104
  * BaseCanaryRunId: "STRING_VALUE", // required
105
+ * BrowserType: "CHROME" || "FIREFOX",
98
106
  * },
99
107
  * ArtifactS3Location: "STRING_VALUE",
100
108
  * ArtifactConfig: { // ArtifactConfigInput
@@ -105,6 +113,25 @@ declare const UpdateCanaryCommand_base: {
105
113
  * },
106
114
  * ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
107
115
  * DryRunId: "STRING_VALUE",
116
+ * VisualReferences: [ // VisualReferences
117
+ * {
118
+ * BaseScreenshots: [
119
+ * {
120
+ * ScreenshotName: "STRING_VALUE", // required
121
+ * IgnoreCoordinates: [
122
+ * "STRING_VALUE",
123
+ * ],
124
+ * },
125
+ * ],
126
+ * BaseCanaryRunId: "STRING_VALUE", // required
127
+ * BrowserType: "CHROME" || "FIREFOX",
128
+ * },
129
+ * ],
130
+ * BrowserConfigs: [ // BrowserConfigs
131
+ * { // BrowserConfig
132
+ * BrowserType: "CHROME" || "FIREFOX",
133
+ * },
134
+ * ],
108
135
  * };
109
136
  * const command = new UpdateCanaryCommand(input);
110
137
  * const response = await client.send(command);
@@ -202,6 +202,29 @@ export interface BaseScreenshot {
202
202
  */
203
203
  IgnoreCoordinates?: string[] | undefined;
204
204
  }
205
+ /**
206
+ * @public
207
+ * @enum
208
+ */
209
+ export declare const BrowserType: {
210
+ readonly CHROME: "CHROME";
211
+ readonly FIREFOX: "FIREFOX";
212
+ };
213
+ /**
214
+ * @public
215
+ */
216
+ export type BrowserType = (typeof BrowserType)[keyof typeof BrowserType];
217
+ /**
218
+ * <p>A structure that specifies the browser type to use for a canary run.</p>
219
+ * @public
220
+ */
221
+ export interface BrowserConfig {
222
+ /**
223
+ * <p>The browser type associated with this browser configuration.</p>
224
+ * @public
225
+ */
226
+ BrowserType?: BrowserType | undefined;
227
+ }
205
228
  /**
206
229
  * @public
207
230
  * @enum
@@ -268,6 +291,23 @@ export interface DryRunConfigOutput {
268
291
  */
269
292
  LastDryRunExecutionStatus?: string | undefined;
270
293
  }
294
+ /**
295
+ * <p>A structure of engine configurations for the canary, one for each browser type that the canary is configured to run on.</p>
296
+ * @public
297
+ */
298
+ export interface EngineConfig {
299
+ /**
300
+ * <p>Each engine configuration contains the ARN of the Lambda function that is used as the canary's engine for a specific browser type.
301
+ * </p>
302
+ * @public
303
+ */
304
+ EngineArn?: string | undefined;
305
+ /**
306
+ * <p>The browser type associated with this engine configuration.</p>
307
+ * @public
308
+ */
309
+ BrowserType?: BrowserType | undefined;
310
+ }
271
311
  /**
272
312
  * @public
273
313
  * @enum
@@ -461,6 +501,11 @@ export interface VisualReferenceOutput {
461
501
  * @public
462
502
  */
463
503
  BaseCanaryRunId?: string | undefined;
504
+ /**
505
+ * <p>The browser type associated with this visual reference.</p>
506
+ * @public
507
+ */
508
+ BrowserType?: BrowserType | undefined;
464
509
  }
465
510
  /**
466
511
  * <p>If this canary is to test an endpoint in a VPC, this structure contains
@@ -599,6 +644,31 @@ export interface Canary {
599
644
  * @public
600
645
  */
601
646
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
647
+ /**
648
+ * <p>A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both <code>CHROME</code> and <code>FIREFOX</code> browsers.</p>
649
+ * <note>
650
+ * <p>If not specified, <code>browserConfigs</code> defaults to Chrome.</p>
651
+ * </note>
652
+ * @public
653
+ */
654
+ BrowserConfigs?: BrowserConfig[] | undefined;
655
+ /**
656
+ * <p>A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.</p>
657
+ * <p>All runtime versions <code>syn-nodejs-puppeteer-11.0</code> and above, and <code>syn-nodejs-playwright-3.0</code> and above, use <code>engineConfigs</code> only.
658
+ * You can no longer use <code>engineArn</code> in these versions.</p>
659
+ * <p>Runtime versions older than <code>syn-nodejs-puppeteer-11.0</code> and <code>syn-nodejs-playwright-3.0</code> continue to support <code>engineArn</code> to ensure backward compatibility.</p>
660
+ * @public
661
+ */
662
+ EngineConfigs?: EngineConfig[] | undefined;
663
+ /**
664
+ * <p>A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.</p>
665
+ * <p>
666
+ * <code>syn-nodejs-puppeteer-11.0</code> and above, and <code>syn-nodejs-playwright-3.0</code> and above, only supports <code>visualReferences</code>. <code>visualReference</code> field is not supported.</p>
667
+ * <p>Versions older than <code>syn-nodejs-puppeteer-11.0</code> supports both <code>visualReference</code> and <code>visualReferences</code> for backward compatibility. It is recommended to use <code>visualReferences</code>
668
+ * for consistency and future compatibility.</p>
669
+ * @public
670
+ */
671
+ VisualReferences?: VisualReferenceOutput[] | undefined;
602
672
  /**
603
673
  * <p>The list of key-value pairs that are associated with the canary.</p>
604
674
  * @public
@@ -762,6 +832,11 @@ export interface CanaryRun {
762
832
  * @public
763
833
  */
764
834
  DryRunConfig?: CanaryDryRunConfigOutput | undefined;
835
+ /**
836
+ * <p>The browser type associated with this canary run.</p>
837
+ * @public
838
+ */
839
+ BrowserType?: BrowserType | undefined;
765
840
  }
766
841
  /**
767
842
  * <p>This structure contains information about the most recent run of a single canary.</p>
@@ -1139,6 +1214,15 @@ export interface CreateCanaryRequest {
1139
1214
  * @public
1140
1215
  */
1141
1216
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
1217
+ /**
1218
+ * <p>CloudWatch Synthetics now supports multibrowser canaries for <code>syn-nodejs-puppeteer-11.0</code> and <code>syn-nodejs-playwright-3.0</code> runtimes. This feature allows you to run your canaries on both
1219
+ * Firefox and Chrome browsers. To create a multibrowser canary, you need to specify the BrowserConfigs with a list of browsers you want to use.</p>
1220
+ * <note>
1221
+ * <p>If not specified, <code>browserConfigs</code> defaults to Chrome.</p>
1222
+ * </note>
1223
+ * @public
1224
+ */
1225
+ BrowserConfigs?: BrowserConfig[] | undefined;
1142
1226
  /**
1143
1227
  * <p>A list of key-value pairs to associate with the canary.
1144
1228
  * You can associate as many as 50 tags with a canary.</p>
@@ -1368,6 +1452,11 @@ export interface DescribeCanariesLastRunRequest {
1368
1452
  * @public
1369
1453
  */
1370
1454
  Names?: string[] | undefined;
1455
+ /**
1456
+ * <p>The type of browser to use for the canary run.</p>
1457
+ * @public
1458
+ */
1459
+ BrowserType?: BrowserType | undefined;
1371
1460
  }
1372
1461
  /**
1373
1462
  * @public
@@ -1849,6 +1938,11 @@ export interface VisualReferenceInput {
1849
1938
  * @public
1850
1939
  */
1851
1940
  BaseCanaryRunId: string | undefined;
1941
+ /**
1942
+ * <p>The browser type associated with this visual reference.</p>
1943
+ * @public
1944
+ */
1945
+ BrowserType?: BrowserType | undefined;
1852
1946
  }
1853
1947
  /**
1854
1948
  * @public
@@ -1968,6 +2062,23 @@ export interface StartCanaryDryRunRequest {
1968
2062
  * @public
1969
2063
  */
1970
2064
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
2065
+ /**
2066
+ * <p>A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both <code>CHROME</code> and <code>FIREFOX</code> browsers.</p>
2067
+ * <note>
2068
+ * <p>If not specified, <code>browserConfigs</code> defaults to Chrome.</p>
2069
+ * </note>
2070
+ * @public
2071
+ */
2072
+ BrowserConfigs?: BrowserConfig[] | undefined;
2073
+ /**
2074
+ * <p>A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.</p>
2075
+ * <p>
2076
+ * <code>syn-nodejs-puppeteer-11.0</code> and above, and <code>syn-nodejs-playwright-3.0</code> and above, only supports <code>visualReferences</code>. <code>visualReference</code> field is not supported.</p>
2077
+ * <p>Versions older than <code>syn-nodejs-puppeteer-11.0</code> supports both <code>visualReference</code> and <code>visualReferences</code> for backward compatibility. It is recommended to use <code>visualReferences</code>
2078
+ * for consistency and future compatibility.</p>
2079
+ * @public
2080
+ */
2081
+ VisualReferences?: VisualReferenceInput[] | undefined;
1971
2082
  }
1972
2083
  /**
1973
2084
  * @public
@@ -2203,6 +2314,27 @@ export interface UpdateCanaryRequest {
2203
2314
  * @public
2204
2315
  */
2205
2316
  DryRunId?: string | undefined;
2317
+ /**
2318
+ * <p>A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.</p>
2319
+ * <p>
2320
+ * <code>syn-nodejs-puppeteer-11.0</code> and above, and <code>syn-nodejs-playwright-3.0</code> and above, only supports <code>visualReferences</code>. <code>visualReference</code> field is not supported.</p>
2321
+ * <p>Versions older than <code>syn-nodejs-puppeteer-11.0</code> supports both <code>visualReference</code> and <code>visualReferences</code> for backward compatibility. It is recommended to use <code>visualReferences</code>
2322
+ * for consistency and future compatibility.</p>
2323
+ * <p>For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser.
2324
+ * Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.</p>
2325
+ * <p>For single configuration canaries using Chrome browser (default browser), use visualReferences for <code>syn-nodejs-puppeteer-11.0</code> and above, and <code>syn-nodejs-playwright-3.0</code> and
2326
+ * above canaries. The browserType in the visualReference object is not mandatory.</p>
2327
+ * @public
2328
+ */
2329
+ VisualReferences?: VisualReferenceInput[] | undefined;
2330
+ /**
2331
+ * <p>A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both <code>CHROME</code> and <code>FIREFOX</code> browsers.</p>
2332
+ * <note>
2333
+ * <p>If not specified, <code>browserConfigs</code> defaults to Chrome.</p>
2334
+ * </note>
2335
+ * @public
2336
+ */
2337
+ BrowserConfigs?: BrowserConfig[] | undefined;
2206
2338
  }
2207
2339
  /**
2208
2340
  * @public
@@ -79,6 +79,14 @@ export interface BaseScreenshot {
79
79
  ScreenshotName: string | undefined;
80
80
  IgnoreCoordinates?: string[] | undefined;
81
81
  }
82
+ export declare const BrowserType: {
83
+ readonly CHROME: "CHROME";
84
+ readonly FIREFOX: "FIREFOX";
85
+ };
86
+ export type BrowserType = (typeof BrowserType)[keyof typeof BrowserType];
87
+ export interface BrowserConfig {
88
+ BrowserType?: BrowserType | undefined;
89
+ }
82
90
  export declare const DependencyType: {
83
91
  readonly LambdaLayer: "LambdaLayer";
84
92
  };
@@ -97,6 +105,10 @@ export interface DryRunConfigOutput {
97
105
  DryRunId?: string | undefined;
98
106
  LastDryRunExecutionStatus?: string | undefined;
99
107
  }
108
+ export interface EngineConfig {
109
+ EngineArn?: string | undefined;
110
+ BrowserType?: BrowserType | undefined;
111
+ }
100
112
  export declare const ProvisionedResourceCleanupSetting: {
101
113
  readonly AUTOMATIC: "AUTOMATIC";
102
114
  readonly OFF: "OFF";
@@ -159,6 +171,7 @@ export interface CanaryTimeline {
159
171
  export interface VisualReferenceOutput {
160
172
  BaseScreenshots?: BaseScreenshot[] | undefined;
161
173
  BaseCanaryRunId?: string | undefined;
174
+ BrowserType?: BrowserType | undefined;
162
175
  }
163
176
  export interface VpcConfigOutput {
164
177
  VpcId?: string | undefined;
@@ -183,6 +196,9 @@ export interface Canary {
183
196
  VpcConfig?: VpcConfigOutput | undefined;
184
197
  VisualReference?: VisualReferenceOutput | undefined;
185
198
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
199
+ BrowserConfigs?: BrowserConfig[] | undefined;
200
+ EngineConfigs?: EngineConfig[] | undefined;
201
+ VisualReferences?: VisualReferenceOutput[] | undefined;
186
202
  Tags?: Record<string, string> | undefined;
187
203
  ArtifactConfig?: ArtifactConfigOutput | undefined;
188
204
  DryRunConfig?: DryRunConfigOutput | undefined;
@@ -230,6 +246,7 @@ export interface CanaryRun {
230
246
  Timeline?: CanaryRunTimeline | undefined;
231
247
  ArtifactS3Location?: string | undefined;
232
248
  DryRunConfig?: CanaryDryRunConfigOutput | undefined;
249
+ BrowserType?: BrowserType | undefined;
233
250
  }
234
251
  export interface CanaryLastRun {
235
252
  CanaryName?: string | undefined;
@@ -280,6 +297,7 @@ export interface CreateCanaryRequest {
280
297
  VpcConfig?: VpcConfigInput | undefined;
281
298
  ResourcesToReplicateTags?: ResourceToTag[] | undefined;
282
299
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
300
+ BrowserConfigs?: BrowserConfig[] | undefined;
283
301
  Tags?: Record<string, string> | undefined;
284
302
  ArtifactConfig?: ArtifactConfigInput | undefined;
285
303
  }
@@ -331,6 +349,7 @@ export interface DescribeCanariesLastRunRequest {
331
349
  NextToken?: string | undefined;
332
350
  MaxResults?: number | undefined;
333
351
  Names?: string[] | undefined;
352
+ BrowserType?: BrowserType | undefined;
334
353
  }
335
354
  export interface DescribeCanariesLastRunResponse {
336
355
  CanariesLastRun?: CanaryLastRun[] | undefined;
@@ -450,6 +469,7 @@ export interface StartCanaryResponse {}
450
469
  export interface VisualReferenceInput {
451
470
  BaseScreenshots?: BaseScreenshot[] | undefined;
452
471
  BaseCanaryRunId: string | undefined;
472
+ BrowserType?: BrowserType | undefined;
453
473
  }
454
474
  export interface StartCanaryDryRunRequest {
455
475
  Name: string | undefined;
@@ -464,6 +484,8 @@ export interface StartCanaryDryRunRequest {
464
484
  ArtifactS3Location?: string | undefined;
465
485
  ArtifactConfig?: ArtifactConfigInput | undefined;
466
486
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
487
+ BrowserConfigs?: BrowserConfig[] | undefined;
488
+ VisualReferences?: VisualReferenceInput[] | undefined;
467
489
  }
468
490
  export interface StartCanaryDryRunResponse {
469
491
  DryRunConfig?: DryRunConfigOutput | undefined;
@@ -497,5 +519,7 @@ export interface UpdateCanaryRequest {
497
519
  ArtifactConfig?: ArtifactConfigInput | undefined;
498
520
  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
499
521
  DryRunId?: string | undefined;
522
+ VisualReferences?: VisualReferenceInput[] | undefined;
523
+ BrowserConfigs?: BrowserConfig[] | undefined;
500
524
  }
501
525
  export interface UpdateCanaryResponse {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-synthetics",
3
3
  "description": "AWS SDK for JavaScript Synthetics Client for Node.js, Browser and React Native",
4
- "version": "3.872.0",
4
+ "version": "3.874.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-synthetics",
@@ -20,17 +20,17 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.864.0",
24
- "@aws-sdk/credential-provider-node": "3.872.0",
25
- "@aws-sdk/middleware-host-header": "3.862.0",
26
- "@aws-sdk/middleware-logger": "3.862.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.862.0",
28
- "@aws-sdk/middleware-user-agent": "3.864.0",
29
- "@aws-sdk/region-config-resolver": "3.862.0",
23
+ "@aws-sdk/core": "3.873.0",
24
+ "@aws-sdk/credential-provider-node": "3.873.0",
25
+ "@aws-sdk/middleware-host-header": "3.873.0",
26
+ "@aws-sdk/middleware-logger": "3.873.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.873.0",
28
+ "@aws-sdk/middleware-user-agent": "3.873.0",
29
+ "@aws-sdk/region-config-resolver": "3.873.0",
30
30
  "@aws-sdk/types": "3.862.0",
31
- "@aws-sdk/util-endpoints": "3.862.0",
32
- "@aws-sdk/util-user-agent-browser": "3.862.0",
33
- "@aws-sdk/util-user-agent-node": "3.864.0",
31
+ "@aws-sdk/util-endpoints": "3.873.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.873.0",
33
+ "@aws-sdk/util-user-agent-node": "3.873.0",
34
34
  "@smithy/config-resolver": "^4.1.5",
35
35
  "@smithy/core": "^3.8.0",
36
36
  "@smithy/fetch-http-handler": "^5.1.1",