Skip to content

Commit b09e934

Browse files
author
awstools
committed
feat(client-synthetics): Added multi browser support for synthetics canaries, Increased ephemeral storage limit from 5GB to 10GB
1 parent c031581 commit b09e934

File tree

10 files changed

+480
-50
lines changed

10 files changed

+480
-50
lines changed

‎clients/client-synthetics/src/commands/CreateCanaryCommand.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
9797
* "lambda-function",
9898
* ],
9999
* ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
100+
* BrowserConfigs: [ // BrowserConfigs
101+
* { // BrowserConfig
102+
* BrowserType: "CHROME" || "FIREFOX",
103+
* },
104+
* ],
100105
* Tags: { // TagMap
101106
* "<keys>": "STRING_VALUE",
102107
* },
@@ -173,8 +178,34 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
173178
* // },
174179
* // ],
175180
* // BaseCanaryRunId: "STRING_VALUE",
181+
* // BrowserType: "CHROME" || "FIREFOX",
176182
* // },
177183
* // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
184+
* // BrowserConfigs: [ // BrowserConfigs
185+
* // { // BrowserConfig
186+
* // BrowserType: "CHROME" || "FIREFOX",
187+
* // },
188+
* // ],
189+
* // EngineConfigs: [ // EngineConfigs
190+
* // { // EngineConfig
191+
* // EngineArn: "STRING_VALUE",
192+
* // BrowserType: "CHROME" || "FIREFOX",
193+
* // },
194+
* // ],
195+
* // VisualReferences: [ // VisualReferencesOutput
196+
* // {
197+
* // BaseScreenshots: [
198+
* // {
199+
* // ScreenshotName: "STRING_VALUE", // required
200+
* // IgnoreCoordinates: [
201+
* // "STRING_VALUE",
202+
* // ],
203+
* // },
204+
* // ],
205+
* // BaseCanaryRunId: "STRING_VALUE",
206+
* // BrowserType: "CHROME" || "FIREFOX",
207+
* // },
208+
* // ],
178209
* // Tags: { // TagMap
179210
* // "<keys>": "STRING_VALUE",
180211
* // },

‎clients/client-synthetics/src/commands/DescribeCanariesCommand.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,34 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
118118
* // },
119119
* // ],
120120
* // BaseCanaryRunId: "STRING_VALUE",
121+
* // BrowserType: "CHROME" || "FIREFOX",
121122
* // },
122123
* // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
124+
* // BrowserConfigs: [ // BrowserConfigs
125+
* // { // BrowserConfig
126+
* // BrowserType: "CHROME" || "FIREFOX",
127+
* // },
128+
* // ],
129+
* // EngineConfigs: [ // EngineConfigs
130+
* // { // EngineConfig
131+
* // EngineArn: "STRING_VALUE",
132+
* // BrowserType: "CHROME" || "FIREFOX",
133+
* // },
134+
* // ],
135+
* // VisualReferences: [ // VisualReferencesOutput
136+
* // {
137+
* // BaseScreenshots: [
138+
* // {
139+
* // ScreenshotName: "STRING_VALUE", // required
140+
* // IgnoreCoordinates: [
141+
* // "STRING_VALUE",
142+
* // ],
143+
* // },
144+
* // ],
145+
* // BaseCanaryRunId: "STRING_VALUE",
146+
* // BrowserType: "CHROME" || "FIREFOX",
147+
* // },
148+
* // ],
123149
* // Tags: { // TagMap
124150
* // "<keys>": "STRING_VALUE",
125151
* // },

‎clients/client-synthetics/src/commands/DescribeCanariesLastRunCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
4949
* Names: [ // DescribeCanariesLastRunNameFilter
5050
* "STRING_VALUE",
5151
* ],
52+
* BrowserType: "CHROME" || "FIREFOX",
5253
* };
5354
* const command = new DescribeCanariesLastRunCommand(input);
5455
* const response = await client.send(command);
@@ -76,6 +77,7 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
7677
* // DryRunConfig: { // CanaryDryRunConfigOutput
7778
* // DryRunId: "STRING_VALUE",
7879
* // },
80+
* // BrowserType: "CHROME" || "FIREFOX",
7981
* // },
8082
* // },
8183
* // ],

‎clients/client-synthetics/src/commands/GetCanaryCommand.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,34 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
107107
* // },
108108
* // ],
109109
* // BaseCanaryRunId: "STRING_VALUE",
110+
* // BrowserType: "CHROME" || "FIREFOX",
110111
* // },
111112
* // ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
113+
* // BrowserConfigs: [ // BrowserConfigs
114+
* // { // BrowserConfig
115+
* // BrowserType: "CHROME" || "FIREFOX",
116+
* // },
117+
* // ],
118+
* // EngineConfigs: [ // EngineConfigs
119+
* // { // EngineConfig
120+
* // EngineArn: "STRING_VALUE",
121+
* // BrowserType: "CHROME" || "FIREFOX",
122+
* // },
123+
* // ],
124+
* // VisualReferences: [ // VisualReferencesOutput
125+
* // {
126+
* // BaseScreenshots: [
127+
* // {
128+
* // ScreenshotName: "STRING_VALUE", // required
129+
* // IgnoreCoordinates: [
130+
* // "STRING_VALUE",
131+
* // ],
132+
* // },
133+
* // ],
134+
* // BaseCanaryRunId: "STRING_VALUE",
135+
* // BrowserType: "CHROME" || "FIREFOX",
136+
* // },
137+
* // ],
112138
* // Tags: { // TagMap
113139
* // "<keys>": "STRING_VALUE",
114140
* // },

‎clients/client-synthetics/src/commands/GetCanaryRunsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met
6666
* // DryRunConfig: { // CanaryDryRunConfigOutput
6767
* // DryRunId: "STRING_VALUE",
6868
* // },
69+
* // BrowserType: "CHROME" || "FIREFOX",
6970
* // },
7071
* // ],
7172
* // NextToken: "STRING_VALUE",

‎clients/client-synthetics/src/commands/StartCanaryDryRunCommand.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ export interface StartCanaryDryRunCommandOutput extends StartCanaryDryRunRespons
8282
* },
8383
* ],
8484
* BaseCanaryRunId: "STRING_VALUE", // required
85+
* BrowserType: "CHROME" || "FIREFOX",
8586
* },
8687
* ArtifactS3Location: "STRING_VALUE",
8788
* ArtifactConfig: { // ArtifactConfigInput
@@ -91,6 +92,25 @@ export interface StartCanaryDryRunCommandOutput extends StartCanaryDryRunRespons
9192
* },
9293
* },
9394
* ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
95+
* BrowserConfigs: [ // BrowserConfigs
96+
* { // BrowserConfig
97+
* BrowserType: "CHROME" || "FIREFOX",
98+
* },
99+
* ],
100+
* VisualReferences: [ // VisualReferences
101+
* {
102+
* BaseScreenshots: [
103+
* {
104+
* ScreenshotName: "STRING_VALUE", // required
105+
* IgnoreCoordinates: [
106+
* "STRING_VALUE",
107+
* ],
108+
* },
109+
* ],
110+
* BaseCanaryRunId: "STRING_VALUE", // required
111+
* BrowserType: "CHROME" || "FIREFOX",
112+
* },
113+
* ],
94114
* };
95115
* const command = new StartCanaryDryRunCommand(input);
96116
* const response = await client.send(command);

‎clients/client-synthetics/src/commands/UpdateCanaryCommand.ts

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,17 @@ export interface UpdateCanaryCommandInput extends UpdateCanaryRequest {}
2828
export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates the configuration of a canary that has
32-
* already been created.</p>
33-
* <p>You can't use this operation to update the tags of an existing canary. To
34-
* change the tags of an existing canary, use
31+
* <p>Updates the configuration of a canary that has already been created.</p>
32+
* <p>For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example:</p>
33+
* <ul>
34+
* <li>
35+
* <p>To add Firefox to a canary that currently uses Chrome, specify browserConfigs as [CHROME, FIREFOX]</p>
36+
* </li>
37+
* <li>
38+
* <p>To remove Firefox and keep only Chrome, specify browserConfigs as [CHROME]</p>
39+
* </li>
40+
* </ul>
41+
* <p>You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use
3542
* <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
3643
* <note>
3744
* <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>
@@ -96,6 +103,7 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
96103
* },
97104
* ],
98105
* BaseCanaryRunId: "STRING_VALUE", // required
106+
* BrowserType: "CHROME" || "FIREFOX",
99107
* },
100108
* ArtifactS3Location: "STRING_VALUE",
101109
* ArtifactConfig: { // ArtifactConfigInput
@@ -106,6 +114,25 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
106114
* },
107115
* ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
108116
* DryRunId: "STRING_VALUE",
117+
* VisualReferences: [ // VisualReferences
118+
* {
119+
* BaseScreenshots: [
120+
* {
121+
* ScreenshotName: "STRING_VALUE", // required
122+
* IgnoreCoordinates: [
123+
* "STRING_VALUE",
124+
* ],
125+
* },
126+
* ],
127+
* BaseCanaryRunId: "STRING_VALUE", // required
128+
* BrowserType: "CHROME" || "FIREFOX",
129+
* },
130+
* ],
131+
* BrowserConfigs: [ // BrowserConfigs
132+
* { // BrowserConfig
133+
* BrowserType: "CHROME" || "FIREFOX",
134+
* },
135+
* ],
109136
* };
110137
* const command = new UpdateCanaryCommand(input);
111138
* const response = await client.send(command);

0 commit comments

Comments
 (0)