@aws-sdk/client-synthetics 3.806.0 → 3.807.0

package/dist-cjs/index.js

@@ -1391,6 +1391,8 @@ var de_CanaryRun = /* @__PURE__ */ __name((output, context) => {
     DryRunConfig: import_smithy_client._json,
     Id: import_smithy_client.expectString,
     Name: import_smithy_client.expectString,
+    RetryAttempt: import_smithy_client.expectInt32,
+    ScheduledRunId: import_smithy_client.expectString,
     Status: import_smithy_client._json,
     Timeline: /* @__PURE__ */ __name((_) => de_CanaryRunTimeline(_, context), "Timeline")
   });
@@ -1404,6 +1406,7 @@ var de_CanaryRuns = /* @__PURE__ */ __name((output, context) => {
 var de_CanaryRunTimeline = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     Completed: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "Completed"),
+    MetricTimestampForRunAndRetries: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "MetricTimestampForRunAndRetries"),
     Started: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "Started")
   });
 }, "de_CanaryRunTimeline");

package/dist-es/protocols/Aws_restJson1.js

@@ -853,6 +853,8 @@ const de_CanaryRun = (output, context) => {
         DryRunConfig: _json,
         Id: __expectString,
         Name: __expectString,
+        RetryAttempt: __expectInt32,
+        ScheduledRunId: __expectString,
         Status: _json,
         Timeline: (_) => de_CanaryRunTimeline(_, context),
     });
@@ -868,6 +870,7 @@ const de_CanaryRuns = (output, context) => {
 const de_CanaryRunTimeline = (output, context) => {
     return take(output, {
         Completed: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+        MetricTimestampForRunAndRetries: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         Started: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     });
 };

package/dist-types/commands/CreateCanaryCommand.d.ts

@@ -61,6 +61,9 @@ declare const CreateCanaryCommand_base: {
  *   Schedule: { // CanaryScheduleInput
  *     Expression: "STRING_VALUE", // required
  *     DurationInSeconds: Number("long"),
+ *     RetryConfig: { // RetryConfigInput
+ *       MaxRetries: Number("int"), // required
+ *     },
  *   },
  *   RunConfig: { // CanaryRunConfigInput
  *     TimeoutInSeconds: Number("int"),
@@ -110,6 +113,9 @@ declare const CreateCanaryCommand_base: {
  * //     Schedule: { // CanaryScheduleOutput
  * //       Expression: "STRING_VALUE",
  * //       DurationInSeconds: Number("long"),
+ * //       RetryConfig: { // RetryConfigOutput
+ * //         MaxRetries: Number("int"),
+ * //       },
  * //     },
  * //     RunConfig: { // CanaryRunConfigOutput
  * //       TimeoutInSeconds: Number("int"),

package/dist-types/commands/DescribeCanariesCommand.d.ts

@@ -65,6 +65,9 @@ declare const DescribeCanariesCommand_base: {
  * //       Schedule: { // CanaryScheduleOutput
  * //         Expression: "STRING_VALUE",
  * //         DurationInSeconds: Number("long"),
+ * //         RetryConfig: { // RetryConfigOutput
+ * //           MaxRetries: Number("int"),
+ * //         },
  * //       },
  * //       RunConfig: { // CanaryRunConfigOutput
  * //         TimeoutInSeconds: Number("int"),

package/dist-types/commands/DescribeCanariesLastRunCommand.d.ts

@@ -57,6 +57,8 @@ declare const DescribeCanariesLastRunCommand_base: {
  * //       CanaryName: "STRING_VALUE",
  * //       LastRun: { // CanaryRun
  * //         Id: "STRING_VALUE",
+ * //         ScheduledRunId: "STRING_VALUE",
+ * //         RetryAttempt: Number("int"),
  * //         Name: "STRING_VALUE",
  * //         Status: { // CanaryRunStatus
  * //           State: "RUNNING" || "PASSED" || "FAILED",
@@ -66,6 +68,7 @@ declare const DescribeCanariesLastRunCommand_base: {
  * //         Timeline: { // CanaryRunTimeline
  * //           Started: new Date("TIMESTAMP"),
  * //           Completed: new Date("TIMESTAMP"),
+ * //           MetricTimestampForRunAndRetries: new Date("TIMESTAMP"),
  * //         },
  * //         ArtifactS3Location: "STRING_VALUE",
  * //         DryRunConfig: { // CanaryDryRunConfigOutput

package/dist-types/commands/GetCanaryCommand.d.ts

@@ -54,6 +54,9 @@ declare const GetCanaryCommand_base: {
  * //     Schedule: { // CanaryScheduleOutput
  * //       Expression: "STRING_VALUE",
  * //       DurationInSeconds: Number("long"),
+ * //       RetryConfig: { // RetryConfigOutput
+ * //         MaxRetries: Number("int"),
+ * //       },
  * //     },
  * //     RunConfig: { // CanaryRunConfigOutput
  * //       TimeoutInSeconds: Number("int"),

package/dist-types/commands/GetCanaryRunsCommand.d.ts

@@ -47,6 +47,8 @@ declare const GetCanaryRunsCommand_base: {
  * //   CanaryRuns: [ // CanaryRuns
  * //     { // CanaryRun
  * //       Id: "STRING_VALUE",
+ * //       ScheduledRunId: "STRING_VALUE",
+ * //       RetryAttempt: Number("int"),
  * //       Name: "STRING_VALUE",
  * //       Status: { // CanaryRunStatus
  * //         State: "RUNNING" || "PASSED" || "FAILED",
@@ -56,6 +58,7 @@ declare const GetCanaryRunsCommand_base: {
  * //       Timeline: { // CanaryRunTimeline
  * //         Started: new Date("TIMESTAMP"),
  * //         Completed: new Date("TIMESTAMP"),
+ * //         MetricTimestampForRunAndRetries: new Date("TIMESTAMP"),
  * //       },
  * //       ArtifactS3Location: "STRING_VALUE",
  * //       DryRunConfig: { // CanaryDryRunConfigOutput

package/dist-types/commands/UpdateCanaryCommand.d.ts

@@ -55,6 +55,9 @@ declare const UpdateCanaryCommand_base: {
  *   Schedule: { // CanaryScheduleInput
  *     Expression: "STRING_VALUE", // required
  *     DurationInSeconds: Number("long"),
+ *     RetryConfig: { // RetryConfigInput
+ *       MaxRetries: Number("int"), // required
+ *     },
  *   },
  *   RunConfig: { // CanaryRunConfigInput
  *     TimeoutInSeconds: Number("int"),

package/dist-types/models/models_0.d.ts

@@ -269,6 +269,17 @@ export interface CanaryRunConfigOutput {
      */
     ActiveTracing?: boolean | undefined;
 }
+/**
+ * <p>This structure contains information about the canary's retry configuration.</p>
+ * @public
+ */
+export interface RetryConfigOutput {
+    /**
+     * <p>The maximum number of retries. The value must be less than or equal to 2.</p>
+     * @public
+     */
+    MaxRetries?: number | undefined;
+}
 /**
  * <p>How long, in seconds, for the canary to continue making regular runs according to the schedule in the
  *          <code>Expression</code> value.</p>
@@ -300,6 +311,11 @@ export interface CanaryScheduleOutput {
      * @public
      */
     DurationInSeconds?: number | undefined;
+    /**
+     * <p>A structure that contains the retry configuration for a canary</p>
+     * @public
+     */
+    RetryConfig?: RetryConfigOutput | undefined;
 }
 /**
  * @public
@@ -353,12 +369,12 @@ export interface CanaryStatus {
      */
     State?: CanaryState | undefined;
     /**
-     * <p>If the canary has insufficient permissions to run, this field provides more details.</p>
+     * <p>If the canary creation or update failed, this field provides details on the failure.</p>
      * @public
      */
     StateReason?: string | undefined;
     /**
-     * <p>If the canary cannot run or has failed, this field displays the reason.</p>
+     * <p>If the canary creation or update failed, this field displays the reason code.</p>
      * @public
      */
     StateReasonCode?: CanaryStateReasonCode | undefined;
@@ -636,6 +652,11 @@ export interface CanaryRunTimeline {
      * @public
      */
     Completed?: Date | undefined;
+    /**
+     * <p>The time at which the metrics will be generated for this run or retries.</p>
+     * @public
+     */
+    MetricTimestampForRunAndRetries?: Date | undefined;
 }
 /**
  * <p>This structure contains the details about one run of one canary.</p>
@@ -647,6 +668,16 @@ export interface CanaryRun {
      * @public
      */
     Id?: string | undefined;
+    /**
+     * <p>The ID of the scheduled canary run.</p>
+     * @public
+     */
+    ScheduledRunId?: string | undefined;
+    /**
+     * <p>The count in number of the retry attempt.</p>
+     * @public
+     */
+    RetryAttempt?: number | undefined;
     /**
      * <p>The name of the canary.</p>
      * @public
@@ -807,6 +838,24 @@ export interface CanaryRunConfigInput {
      */
     EnvironmentVariables?: Record<string, string> | undefined;
 }
+/**
+ * <p>This structure contains information about the canary's retry configuration.</p>
+ *          <note>
+ *             <p>The default account level concurrent execution limit from Lambda is 1000. When you have more than 1000 canaries, it's possible there are more than 1000 Lambda invocations due to retries and the console might hang. For more information on the Lambda execution limit,
+ *             see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-concurrency.html#:~:text=As%20your%20functions%20receive%20more,functions%20in%20an%20AWS%20Region">Understanding Lambda function scaling</a>.</p>
+ *          </note>
+ *          <note>
+ *             <p>For canary with <code>MaxRetries = 2</code>, you need to set the <code>CanaryRunConfigInput.TimeoutInSeconds</code> to less than 600 seconds to avoid validation errors.</p>
+ *          </note>
+ * @public
+ */
+export interface RetryConfigInput {
+    /**
+     * <p>The maximum number of retries. The value must be less than or equal to 2.</p>
+     * @public
+     */
+    MaxRetries: number | undefined;
+}
 /**
  * <p>This structure specifies how often a canary is to make runs and the date and time
  *          when it should stop making runs.</p>
@@ -838,6 +887,11 @@ export interface CanaryScheduleInput {
      * @public
      */
     DurationInSeconds?: number | undefined;
+    /**
+     * <p>A structure that contains the retry configuration for a canary</p>
+     * @public
+     */
+    RetryConfig?: RetryConfigInput | undefined;
 }
 /**
  * @public
@@ -1402,6 +1456,9 @@ export interface GetCanaryRunsRequest {
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next
      *          set of results.</p>
+     *          <note>
+     *             <p>When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.</p>
+     *          </note>
      * @public
      */
     NextToken?: string | undefined;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -98,9 +98,13 @@ export interface CanaryRunConfigOutput {
   MemoryInMB?: number | undefined;
   ActiveTracing?: boolean | undefined;
 }
+export interface RetryConfigOutput {
+  MaxRetries?: number | undefined;
+}
 export interface CanaryScheduleOutput {
   Expression?: string | undefined;
   DurationInSeconds?: number | undefined;
+  RetryConfig?: RetryConfigOutput | undefined;
 }
 export declare const CanaryState: {
   readonly CREATING: "CREATING";
@@ -196,9 +200,12 @@ export interface CanaryRunStatus {
 export interface CanaryRunTimeline {
   Started?: Date | undefined;
   Completed?: Date | undefined;
+  MetricTimestampForRunAndRetries?: Date | undefined;
 }
 export interface CanaryRun {
   Id?: string | undefined;
+  ScheduledRunId?: string | undefined;
+  RetryAttempt?: number | undefined;
   Name?: string | undefined;
   Status?: CanaryRunStatus | undefined;
   Timeline?: CanaryRunTimeline | undefined;
@@ -222,9 +229,13 @@ export interface CanaryRunConfigInput {
   ActiveTracing?: boolean | undefined;
   EnvironmentVariables?: Record<string, string> | undefined;
 }
+export interface RetryConfigInput {
+  MaxRetries: number | undefined;
+}
 export interface CanaryScheduleInput {
   Expression: string | undefined;
   DurationInSeconds?: number | undefined;
+  RetryConfig?: RetryConfigInput | undefined;
 }
 export declare const ResourceToTag: {
   readonly LAMBDA_FUNCTION: "lambda-function";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-synthetics",
   "description": "AWS SDK for JavaScript Synthetics Client for Node.js, Browser and React Native",
-  "version": "3.806.0",
+  "version": "3.807.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-synthetics",