aws-sdk-synthetics 1.63.0 → 1.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e2e604c8e69e90705a06f9a523205968bb637ade37e418bde59b995ded9961
-  data.tar.gz: fa0764ec1e04f4f56e570edbe7ee5858958fe2de39f8e964830d57a911c86f57
+  metadata.gz: f2f10eca2913a43646fb0d7dad579d5fbbb8ff68317f9f4fccd3e4dab3f6225e
+  data.tar.gz: bd07a39420ada92596e0352cddfb0468c8c151189c5740cb558083ea446362dd
 SHA512:
-  metadata.gz: b838784f6f386ed4f86280ae4ca3d4ea71a2de5f8df8735b52363284e86e6540e2212fd81372f859ae54c1316069a461514e5f9f765f598755f9b3dcb2088784
-  data.tar.gz: 8038523fce046a99fc49bf96a177a6907468e19935c2f94f8a17f615cdaf0b5958213293729ca622aa5ed4b71dd609c950949e91c1922a7355b55f00848bcc7b
+  metadata.gz: 9cea5297a6b133f3ebaa010239ae2ac36f0b7dcdced52069a84633d4c9080f7e6492d4e430642c20f25e87d954b7e2aa56f6c51988bf494983be3e644c201fa5
+  data.tar.gz: 91dc833ef6609777aeaa7fe6546501b57c087dcc9ad3bf50d2d814b467e7db4fbe13393028f8ffc45fdd3d753f99b8881f7941b4fcbf192ef55b684145758b21

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.64.0 (2025-05-09)
+------------------
+
+* Feature - Add support to retry a canary automatically after schedule run failures. Users can enable this feature by configuring the RetryConfig field when calling the CreateCanary or UpdateCanary API. Also includes changes in GetCanary and GetCanaryRuns to support retrieving retry configurations.
+
 1.63.0 (2025-05-07)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.63.0
+1.64.0

data/lib/aws-sdk-synthetics/client.rb

@@ -688,6 +688,9 @@ module Aws::Synthetics
     #     schedule: { # required
     #       expression: "String", # required
     #       duration_in_seconds: 1,
+    #       retry_config: {
+    #         max_retries: 1, # required
+    #       },
     #     },
     #     run_config: {
     #       timeout_in_seconds: 1,
@@ -727,6 +730,7 @@ module Aws::Synthetics
     #   resp.canary.execution_role_arn #=> String
     #   resp.canary.schedule.expression #=> String
     #   resp.canary.schedule.duration_in_seconds #=> Integer
+    #   resp.canary.schedule.retry_config.max_retries #=> Integer
     #   resp.canary.run_config.timeout_in_seconds #=> Integer
     #   resp.canary.run_config.memory_in_mb #=> Integer
     #   resp.canary.run_config.active_tracing #=> Boolean
@@ -1011,6 +1015,7 @@ module Aws::Synthetics
     #   resp.canaries[0].execution_role_arn #=> String
     #   resp.canaries[0].schedule.expression #=> String
     #   resp.canaries[0].schedule.duration_in_seconds #=> Integer
+    #   resp.canaries[0].schedule.retry_config.max_retries #=> Integer
     #   resp.canaries[0].run_config.timeout_in_seconds #=> Integer
     #   resp.canaries[0].run_config.memory_in_mb #=> Integer
     #   resp.canaries[0].run_config.active_tracing #=> Boolean
@@ -1122,12 +1127,15 @@ module Aws::Synthetics
     #   resp.canaries_last_run #=> Array
     #   resp.canaries_last_run[0].canary_name #=> String
     #   resp.canaries_last_run[0].last_run.id #=> String
+    #   resp.canaries_last_run[0].last_run.scheduled_run_id #=> String
+    #   resp.canaries_last_run[0].last_run.retry_attempt #=> Integer
     #   resp.canaries_last_run[0].last_run.name #=> String
     #   resp.canaries_last_run[0].last_run.status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
     #   resp.canaries_last_run[0].last_run.status.state_reason #=> String
     #   resp.canaries_last_run[0].last_run.status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
     #   resp.canaries_last_run[0].last_run.timeline.started #=> Time
     #   resp.canaries_last_run[0].last_run.timeline.completed #=> Time
+    #   resp.canaries_last_run[0].last_run.timeline.metric_timestamp_for_run_and_retries #=> Time
     #   resp.canaries_last_run[0].last_run.artifact_s3_location #=> String
     #   resp.canaries_last_run[0].last_run.dry_run_config.dry_run_id #=> String
     #   resp.next_token #=> String
@@ -1254,6 +1262,7 @@ module Aws::Synthetics
     #   resp.canary.execution_role_arn #=> String
     #   resp.canary.schedule.expression #=> String
     #   resp.canary.schedule.duration_in_seconds #=> Integer
+    #   resp.canary.schedule.retry_config.max_retries #=> Integer
     #   resp.canary.run_config.timeout_in_seconds #=> Integer
     #   resp.canary.run_config.memory_in_mb #=> Integer
     #   resp.canary.run_config.active_tracing #=> Boolean
@@ -1307,6 +1316,12 @@ module Aws::Synthetics
     #   this token in a subsequent `GetCanaryRuns` operation to retrieve the
     #   next set of results.
     #
+    #   <note markdown="1"> 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.
+    #
+    #    </note>
+    #
     # @option params [Integer] :max_results
     #   Specify this parameter to limit how many runs are returned each time
     #   you use the `GetCanaryRuns` operation. If you omit this parameter, the
@@ -1350,12 +1365,15 @@ module Aws::Synthetics
     #
     #   resp.canary_runs #=> Array
     #   resp.canary_runs[0].id #=> String
+    #   resp.canary_runs[0].scheduled_run_id #=> String
+    #   resp.canary_runs[0].retry_attempt #=> Integer
     #   resp.canary_runs[0].name #=> String
     #   resp.canary_runs[0].status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
     #   resp.canary_runs[0].status.state_reason #=> String
     #   resp.canary_runs[0].status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
     #   resp.canary_runs[0].timeline.started #=> Time
     #   resp.canary_runs[0].timeline.completed #=> Time
+    #   resp.canary_runs[0].timeline.metric_timestamp_for_run_and_retries #=> Time
     #   resp.canary_runs[0].artifact_s3_location #=> String
     #   resp.canary_runs[0].dry_run_config.dry_run_id #=> String
     #   resp.next_token #=> String
@@ -2090,6 +2108,9 @@ module Aws::Synthetics
     #     schedule: {
     #       expression: "String", # required
     #       duration_in_seconds: 1,
+    #       retry_config: {
+    #         max_retries: 1, # required
+    #       },
     #     },
     #     run_config: {
     #       timeout_in_seconds: 1,
@@ -2153,7 +2174,7 @@ module Aws::Synthetics
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.63.0'
+      context[:gem_version] = '1.64.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-synthetics/client_api.rb

@@ -102,6 +102,7 @@ module Aws::Synthetics
     MaxFifteenMinutesInSeconds = Shapes::IntegerShape.new(name: 'MaxFifteenMinutesInSeconds')
     MaxGroupResults = Shapes::IntegerShape.new(name: 'MaxGroupResults')
     MaxOneYearInSeconds = Shapes::IntegerShape.new(name: 'MaxOneYearInSeconds')
+    MaxRetries = Shapes::IntegerShape.new(name: 'MaxRetries')
     MaxSize100 = Shapes::IntegerShape.new(name: 'MaxSize100')
     MaxSize1024 = Shapes::IntegerShape.new(name: 'MaxSize1024')
     MaxSize3008 = Shapes::IntegerShape.new(name: 'MaxSize3008')
@@ -114,6 +115,9 @@ module Aws::Synthetics
     ResourceList = Shapes::ListShape.new(name: 'ResourceList')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceToTag = Shapes::StringShape.new(name: 'ResourceToTag')
+    RetryAttempt = Shapes::IntegerShape.new(name: 'RetryAttempt')
+    RetryConfigInput = Shapes::StructureShape.new(name: 'RetryConfigInput')
+    RetryConfigOutput = Shapes::StructureShape.new(name: 'RetryConfigOutput')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
     RunType = Shapes::StringShape.new(name: 'RunType')
     RuntimeVersion = Shapes::StructureShape.new(name: 'RuntimeVersion')
@@ -224,6 +228,8 @@ module Aws::Synthetics
     CanaryLastRun.struct_class = Types::CanaryLastRun
 
     CanaryRun.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id"))
+    CanaryRun.add_member(:scheduled_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "ScheduledRunId"))
+    CanaryRun.add_member(:retry_attempt, Shapes::ShapeRef.new(shape: RetryAttempt, location_name: "RetryAttempt"))
     CanaryRun.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, location_name: "Name"))
     CanaryRun.add_member(:status, Shapes::ShapeRef.new(shape: CanaryRunStatus, location_name: "Status"))
     CanaryRun.add_member(:timeline, Shapes::ShapeRef.new(shape: CanaryRunTimeline, location_name: "Timeline"))
@@ -249,16 +255,19 @@ module Aws::Synthetics
 
     CanaryRunTimeline.add_member(:started, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Started"))
     CanaryRunTimeline.add_member(:completed, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Completed"))
+    CanaryRunTimeline.add_member(:metric_timestamp_for_run_and_retries, Shapes::ShapeRef.new(shape: Timestamp, location_name: "MetricTimestampForRunAndRetries"))
     CanaryRunTimeline.struct_class = Types::CanaryRunTimeline
 
     CanaryRuns.member = Shapes::ShapeRef.new(shape: CanaryRun)
 
     CanaryScheduleInput.add_member(:expression, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Expression"))
     CanaryScheduleInput.add_member(:duration_in_seconds, Shapes::ShapeRef.new(shape: MaxOneYearInSeconds, location_name: "DurationInSeconds"))
+    CanaryScheduleInput.add_member(:retry_config, Shapes::ShapeRef.new(shape: RetryConfigInput, location_name: "RetryConfig"))
     CanaryScheduleInput.struct_class = Types::CanaryScheduleInput
 
     CanaryScheduleOutput.add_member(:expression, Shapes::ShapeRef.new(shape: String, location_name: "Expression"))
     CanaryScheduleOutput.add_member(:duration_in_seconds, Shapes::ShapeRef.new(shape: MaxOneYearInSeconds, location_name: "DurationInSeconds"))
+    CanaryScheduleOutput.add_member(:retry_config, Shapes::ShapeRef.new(shape: RetryConfigOutput, location_name: "RetryConfig"))
     CanaryScheduleOutput.struct_class = Types::CanaryScheduleOutput
 
     CanaryStatus.add_member(:state, Shapes::ShapeRef.new(shape: CanaryState, location_name: "State"))
@@ -443,6 +452,12 @@ module Aws::Synthetics
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    RetryConfigInput.add_member(:max_retries, Shapes::ShapeRef.new(shape: MaxRetries, required: true, location_name: "MaxRetries"))
+    RetryConfigInput.struct_class = Types::RetryConfigInput
+
+    RetryConfigOutput.add_member(:max_retries, Shapes::ShapeRef.new(shape: MaxRetries, location_name: "MaxRetries"))
+    RetryConfigOutput.struct_class = Types::RetryConfigOutput
+
     RuntimeVersion.add_member(:version_name, Shapes::ShapeRef.new(shape: String, location_name: "VersionName"))
     RuntimeVersion.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "Description"))
     RuntimeVersion.add_member(:release_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ReleaseDate"))

data/lib/aws-sdk-synthetics/types.rb

@@ -431,6 +431,14 @@ module Aws::Synthetics
     #   A unique ID that identifies this canary run.
     #   @return [String]
     #
+    # @!attribute [rw] scheduled_run_id
+    #   The ID of the scheduled canary run.
+    #   @return [String]
+    #
+    # @!attribute [rw] retry_attempt
+    #   The count in number of the retry attempt.
+    #   @return [Integer]
+    #
     # @!attribute [rw] name
     #   The name of the canary.
     #   @return [String]
@@ -456,6 +464,8 @@ module Aws::Synthetics
     #
     class CanaryRun < Struct.new(
       :id,
+      :scheduled_run_id,
+      :retry_attempt,
       :name,
       :status,
       :timeline,
@@ -593,11 +603,17 @@ module Aws::Synthetics
     #   The end time of the run.
     #   @return [Time]
     #
+    # @!attribute [rw] metric_timestamp_for_run_and_retries
+    #   The time at which the metrics will be generated for this run or
+    #   retries.
+    #   @return [Time]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunTimeline AWS API Documentation
     #
     class CanaryRunTimeline < Struct.new(
       :started,
-      :completed)
+      :completed,
+      :metric_timestamp_for_run_and_retries)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -637,11 +653,16 @@ module Aws::Synthetics
     #   this field, the default of 0 is used.
     #   @return [Integer]
     #
+    # @!attribute [rw] retry_config
+    #   A structure that contains the retry configuration for a canary
+    #   @return [Types::RetryConfigInput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryScheduleInput AWS API Documentation
     #
     class CanaryScheduleInput < Struct.new(
       :expression,
-      :duration_in_seconds)
+      :duration_in_seconds,
+      :retry_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -679,11 +700,16 @@ module Aws::Synthetics
     #   schedule in the `Expression` value.
     #   @return [Integer]
     #
+    # @!attribute [rw] retry_config
+    #   A structure that contains the retry configuration for a canary
+    #   @return [Types::RetryConfigOutput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryScheduleOutput AWS API Documentation
     #
     class CanaryScheduleOutput < Struct.new(
       :expression,
-      :duration_in_seconds)
+      :duration_in_seconds,
+      :retry_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -695,13 +721,13 @@ module Aws::Synthetics
     #   @return [String]
     #
     # @!attribute [rw] state_reason
-    #   If the canary has insufficient permissions to run, this field
-    #   provides more details.
+    #   If the canary creation or update failed, this field provides details
+    #   on the failure.
     #   @return [String]
     #
     # @!attribute [rw] state_reason_code
-    #   If the canary cannot run or has failed, this field displays the
-    #   reason.
+    #   If the canary creation or update failed, this field displays the
+    #   reason code.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryStatus AWS API Documentation
@@ -1281,6 +1307,12 @@ module Aws::Synthetics
     #   A token that indicates that there is more data available. You can
     #   use this token in a subsequent `GetCanaryRuns` operation to retrieve
     #   the next set of results.
+    #
+    #   <note markdown="1"> 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.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -1658,6 +1690,56 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # This structure contains information about the canary's retry
+    # configuration.
+    #
+    # <note markdown="1"> 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
+    # [Understanding Lambda function scaling][1].
+    #
+    #  </note>
+    #
+    # <note markdown="1"> For canary with `MaxRetries = 2`, you need to set the
+    # `CanaryRunConfigInput.TimeoutInSeconds` to less than 600 seconds to
+    # avoid validation errors.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-concurrency.html#:~:text=As%20your%20functions%20receive%20more,functions%20in%20an%20AWS%20Region
+    #
+    # @!attribute [rw] max_retries
+    #   The maximum number of retries. The value must be less than or equal
+    #   to 2.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/RetryConfigInput AWS API Documentation
+    #
+    class RetryConfigInput < Struct.new(
+      :max_retries)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # This structure contains information about the canary's retry
+    # configuration.
+    #
+    # @!attribute [rw] max_retries
+    #   The maximum number of retries. The value must be less than or equal
+    #   to 2.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/RetryConfigOutput AWS API Documentation
+    #
+    class RetryConfigOutput < Struct.new(
+      :max_retries)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This structure contains information about one canary runtime version.
     # For more information about runtime versions, see [ Canary Runtime
     # Versions][1].

data/lib/aws-sdk-synthetics.rb

@@ -54,7 +54,7 @@ module Aws::Synthetics
   autoload :EndpointProvider, 'aws-sdk-synthetics/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-synthetics/endpoints'
 
-  GEM_VERSION = '1.63.0'
+  GEM_VERSION = '1.64.0'
 
 end
 

data/sig/client.rbs

@@ -105,7 +105,10 @@ module Aws
                            execution_role_arn: ::String,
                            schedule: {
                              expression: ::String,
-                             duration_in_seconds: ::Integer?
+                             duration_in_seconds: ::Integer?,
+                             retry_config: {
+                               max_retries: ::Integer
+                             }?
                            },
                            ?run_config: {
                              timeout_in_seconds: ::Integer?,
@@ -399,7 +402,10 @@ module Aws
                            ?runtime_version: ::String,
                            ?schedule: {
                              expression: ::String,
-                             duration_in_seconds: ::Integer?
+                             duration_in_seconds: ::Integer?,
+                             retry_config: {
+                               max_retries: ::Integer
+                             }?
                            },
                            ?run_config: {
                              timeout_in_seconds: ::Integer?,

data/sig/types.rbs

@@ -94,6 +94,8 @@ module Aws::Synthetics
 
     class CanaryRun
       attr_accessor id: ::String
+      attr_accessor scheduled_run_id: ::String
+      attr_accessor retry_attempt: ::Integer
       attr_accessor name: ::String
       attr_accessor status: Types::CanaryRunStatus
       attr_accessor timeline: Types::CanaryRunTimeline
@@ -127,18 +129,21 @@ module Aws::Synthetics
     class CanaryRunTimeline
       attr_accessor started: ::Time
       attr_accessor completed: ::Time
+      attr_accessor metric_timestamp_for_run_and_retries: ::Time
       SENSITIVE: []
     end
 
     class CanaryScheduleInput
       attr_accessor expression: ::String
       attr_accessor duration_in_seconds: ::Integer
+      attr_accessor retry_config: Types::RetryConfigInput
       SENSITIVE: []
     end
 
     class CanaryScheduleOutput
       attr_accessor expression: ::String
       attr_accessor duration_in_seconds: ::Integer
+      attr_accessor retry_config: Types::RetryConfigOutput
       SENSITIVE: []
     end
 
@@ -392,6 +397,16 @@ module Aws::Synthetics
       SENSITIVE: []
     end
 
+    class RetryConfigInput
+      attr_accessor max_retries: ::Integer
+      SENSITIVE: []
+    end
+
+    class RetryConfigOutput
+      attr_accessor max_retries: ::Integer
+      SENSITIVE: []
+    end
+
     class RuntimeVersion
       attr_accessor version_name: ::String
       attr_accessor description: ::String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.63.0
+  version: 1.64.0
 platform: ruby
 authors:
 - Amazon Web Services