aws-sdk-synthetics 1.14.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16a3cf45c70183d8debdb6f6780ec8e3c04738f891681c0f10b63af9c2f057b8
-  data.tar.gz: 1e23c947e3f5d190235033230aaafde009e2354230da71eab810296fa77c29b4
+  metadata.gz: e6a2d323d4f8e8da87fbb96a21610cc0a1300301c775914314c312551997bd7d
+  data.tar.gz: 918bba5c29030af9c150989cded97852a6fe2e5e4860487607a23ca4eea69219
 SHA512:
-  metadata.gz: f7afc6890593033d2e0315a18b2afba827d6cb387d6fee6520d35d95d8bb87f4e6519847886f56f4875f048b87cec48e002bd4cbb6228005171f097f823c5e94
-  data.tar.gz: 140c09a86cb9f4c1fc5ae88431e2d3f5d47e64b2ba234fc3bde7e0939b96d403d4a048f9f74e050a706647745d9a585373cfea0e4a3cd1b5827eabf2ff94ea44
+  metadata.gz: e09c8cf6d4e40adff3aa2ee5821ad0ad93442f4b62180cc9de5ae36b970cfbb898a495251b450f274b231bfa847fc109a6e6cc42e91ac213b9b0f1cacf688caa
+  data.tar.gz: 024665774f9b40a8f060c8fbf681d625c36b1b1a14a1b84613ff92bfcce6293c97cf6316a6678fabf9ead00ff9844f304a5c90208cc12c989e2935aceb4081d4

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.18.0 (2021-10-01)
+------------------
+
+* Feature - CloudWatch Synthetics now enables customers to choose a customer managed AWS KMS key or an Amazon S3-managed key instead of an AWS managed key (default) for the encryption of artifacts that the canary stores in Amazon S3. CloudWatch Synthetics also supports artifact S3 location updation now.
+
+1.17.0 (2021-09-01)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.16.0 (2021-08-06)
+------------------
+
+* Feature - Documentation updates for Visual Monitoring feature and other doc ticket fixes.
+
+1.15.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.14.0 (2021-07-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.14.0
+1.18.0

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

@@ -441,6 +441,11 @@ module Aws::Synthetics
     #   use them to scope user permissions, by granting a user permission to
     #   access or change only the resources that have certain tag values.
     #
+    # @option params [Types::ArtifactConfigInput] :artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #
     # @return [Types::CreateCanaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateCanaryResponse#canary #canary} => Types::Canary
@@ -480,6 +485,12 @@ module Aws::Synthetics
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
+    #     artifact_config: {
+    #       s3_encryption: {
+    #         encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #         kms_key_arn: "KmsKeyArn",
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -518,6 +529,8 @@ module Aws::Synthetics
     #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
+    #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
+    #   resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary AWS API Documentation
     #
@@ -649,6 +662,8 @@ module Aws::Synthetics
     #   resp.canaries[0].visual_reference.base_canary_run_id #=> String
     #   resp.canaries[0].tags #=> Hash
     #   resp.canaries[0].tags["TagKey"] #=> String
+    #   resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
+    #   resp.canaries[0].artifact_config.s3_encryption.kms_key_arn #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries AWS API Documentation
@@ -816,6 +831,8 @@ module Aws::Synthetics
     #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
+    #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
+    #   resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary AWS API Documentation
     #
@@ -1132,6 +1149,29 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #
     # @option params [Types::VisualReferenceInput] :visual_reference
+    #   Defines the screenshots to use as the baseline for comparisons during
+    #   visual monitoring comparisons during future runs of this canary. If
+    #   you omit this parameter, no changes are made to any baseline
+    #   screenshots that the canary might be using already.
+    #
+    #   Visual monitoring is supported only on canaries running the
+    #   **syn-puppeteer-node-3.2** runtime or later. For more information, see
+    #   [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
+    #
+    # @option params [String] :artifact_s3_location
+    #   The location in Amazon S3 where Synthetics stores artifacts from the
+    #   test runs of this canary. Artifacts include the log file, screenshots,
+    #   and HAR files. The name of the S3 bucket can't include a period (.).
+    #
+    # @option params [Types::ArtifactConfigInput] :artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1175,6 +1215,13 @@ module Aws::Synthetics
     #       ],
     #       base_canary_run_id: "String", # required
     #     },
+    #     artifact_s3_location: "String",
+    #     artifact_config: {
+    #       s3_encryption: {
+    #         encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #         kms_key_arn: "KmsKeyArn",
+    #       },
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
@@ -1199,7 +1246,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.14.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -13,6 +13,8 @@ module Aws::Synthetics
 
     include Seahorse::Model
 
+    ArtifactConfigInput = Shapes::StructureShape.new(name: 'ArtifactConfigInput')
+    ArtifactConfigOutput = Shapes::StructureShape.new(name: 'ArtifactConfigOutput')
     BaseScreenshot = Shapes::StructureShape.new(name: 'BaseScreenshot')
     BaseScreenshotConfigIgnoreCoordinate = Shapes::StringShape.new(name: 'BaseScreenshotConfigIgnoreCoordinate')
     BaseScreenshotIgnoreCoordinates = Shapes::ListShape.new(name: 'BaseScreenshotIgnoreCoordinates')
@@ -51,6 +53,7 @@ module Aws::Synthetics
     DescribeCanariesResponse = Shapes::StructureShape.new(name: 'DescribeCanariesResponse')
     DescribeRuntimeVersionsRequest = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsRequest')
     DescribeRuntimeVersionsResponse = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsResponse')
+    EncryptionMode = Shapes::StringShape.new(name: 'EncryptionMode')
     EnvironmentVariableName = Shapes::StringShape.new(name: 'EnvironmentVariableName')
     EnvironmentVariableValue = Shapes::StringShape.new(name: 'EnvironmentVariableValue')
     EnvironmentVariablesMap = Shapes::MapShape.new(name: 'EnvironmentVariablesMap')
@@ -61,6 +64,7 @@ module Aws::Synthetics
     GetCanaryRunsRequest = Shapes::StructureShape.new(name: 'GetCanaryRunsRequest')
     GetCanaryRunsResponse = Shapes::StructureShape.new(name: 'GetCanaryRunsResponse')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
+    KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
     ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
     ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
     MaxCanaryResults = Shapes::IntegerShape.new(name: 'MaxCanaryResults')
@@ -74,6 +78,7 @@ module Aws::Synthetics
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
     RuntimeVersion = Shapes::StructureShape.new(name: 'RuntimeVersion')
     RuntimeVersionList = Shapes::ListShape.new(name: 'RuntimeVersionList')
+    S3EncryptionConfig = Shapes::StructureShape.new(name: 'S3EncryptionConfig')
     SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
     SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
     StartCanaryRequest = Shapes::StructureShape.new(name: 'StartCanaryRequest')
@@ -103,6 +108,12 @@ module Aws::Synthetics
     VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
     VpcId = Shapes::StringShape.new(name: 'VpcId')
 
+    ArtifactConfigInput.add_member(:s3_encryption, Shapes::ShapeRef.new(shape: S3EncryptionConfig, location_name: "S3Encryption"))
+    ArtifactConfigInput.struct_class = Types::ArtifactConfigInput
+
+    ArtifactConfigOutput.add_member(:s3_encryption, Shapes::ShapeRef.new(shape: S3EncryptionConfig, location_name: "S3Encryption"))
+    ArtifactConfigOutput.struct_class = Types::ArtifactConfigOutput
+
     BaseScreenshot.add_member(:screenshot_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ScreenshotName"))
     BaseScreenshot.add_member(:ignore_coordinates, Shapes::ShapeRef.new(shape: BaseScreenshotIgnoreCoordinates, location_name: "IgnoreCoordinates"))
     BaseScreenshot.struct_class = Types::BaseScreenshot
@@ -131,6 +142,7 @@ module Aws::Synthetics
     Canary.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigOutput, location_name: "VpcConfig"))
     Canary.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceOutput, location_name: "VisualReference"))
     Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
+    Canary.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigOutput, location_name: "ArtifactConfig"))
     Canary.struct_class = Types::Canary
 
     CanaryCodeInput.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: String, location_name: "S3Bucket"))
@@ -210,6 +222,7 @@ module Aws::Synthetics
     CreateCanaryRequest.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "RuntimeVersion"))
     CreateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
     CreateCanaryRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
+    CreateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
     CreateCanaryRequest.struct_class = Types::CreateCanaryRequest
 
     CreateCanaryResponse.add_member(:canary, Shapes::ShapeRef.new(shape: Canary, location_name: "Canary"))
@@ -282,6 +295,10 @@ module Aws::Synthetics
 
     RuntimeVersionList.member = Shapes::ShapeRef.new(shape: RuntimeVersion)
 
+    S3EncryptionConfig.add_member(:encryption_mode, Shapes::ShapeRef.new(shape: EncryptionMode, location_name: "EncryptionMode"))
+    S3EncryptionConfig.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
+    S3EncryptionConfig.struct_class = Types::S3EncryptionConfig
+
     SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId)
 
     StartCanaryRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
@@ -323,6 +340,8 @@ module Aws::Synthetics
     UpdateCanaryRequest.add_member(:failure_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "FailureRetentionPeriodInDays"))
     UpdateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
     UpdateCanaryRequest.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceInput, location_name: "VisualReference"))
+    UpdateCanaryRequest.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
+    UpdateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
     UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
 
     UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse

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

@@ -10,6 +10,61 @@
 module Aws::Synthetics
   module Types
 
+    # A structure that contains the configuration for canary artifacts,
+    # including the encryption-at-rest settings for artifacts that the
+    # canary uploads to Amazon S3.
+    #
+    # @note When making an API call, you may pass ArtifactConfigInput
+    #   data as a hash:
+    #
+    #       {
+    #         s3_encryption: {
+    #           encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #           kms_key_arn: "KmsKeyArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] s3_encryption
+    #   A structure that contains the configuration of the
+    #   encryption-at-rest settings for artifacts that the canary uploads to
+    #   Amazon S3. Artifact encryption functionality is available only for
+    #   canaries that use Synthetics runtime version
+    #   syn-nodejs-puppeteer-3.3 or later. For more information, see
+    #   [Encrypting canary artifacts][1]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html
+    #   @return [Types::S3EncryptionConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ArtifactConfigInput AWS API Documentation
+    #
+    class ArtifactConfigInput < Struct.new(
+      :s3_encryption)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A structure that contains the configuration for canary artifacts,
+    # including the encryption-at-rest settings for artifacts that the
+    # canary uploads to Amazon S3.
+    #
+    # @!attribute [rw] s3_encryption
+    #   A structure that contains the configuration of encryption settings
+    #   for canary artifacts that are stored in Amazon S3.
+    #   @return [Types::S3EncryptionConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ArtifactConfigOutput AWS API Documentation
+    #
+    class ArtifactConfigOutput < Struct.new(
+      :s3_encryption)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A structure representing a screenshot that is used as a baseline
+    # during visual monitoring comparisons made by the canary.
+    #
     # @note When making an API call, you may pass BaseScreenshot
     #   data as a hash:
     #
@@ -19,9 +74,16 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] screenshot_name
+    #   The name of the screenshot. This is generated the first time the
+    #   canary is run after the `UpdateCanary` operation that specified for
+    #   this canary to perform visual monitoring.
     #   @return [String]
     #
     # @!attribute [rw] ignore_coordinates
+    #   Coordinates that define the part of a screen to ignore during
+    #   screenshot comparisons. To obtain the coordinates to use here, use
+    #   the CloudWatch Logs console to draw the boundaries on the screen.
+    #   For more information, see \\\{LINK\\}
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BaseScreenshot AWS API Documentation
@@ -119,12 +181,22 @@ module Aws::Synthetics
     #   @return [Types::VpcConfigOutput]
     #
     # @!attribute [rw] visual_reference
+    #   If this canary performs visual monitoring by comparing screenshots,
+    #   this structure contains the ID of the canary run to use as the
+    #   baseline for screenshots, and the coordinates of any parts of the
+    #   screen to ignore during the visual monitoring comparison.
     #   @return [Types::VisualReferenceOutput]
     #
     # @!attribute [rw] tags
     #   The list of key-value pairs that are associated with the canary.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #   @return [Types::ArtifactConfigOutput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/Canary AWS API Documentation
     #
     class Canary < Struct.new(
@@ -143,7 +215,8 @@ module Aws::Synthetics
       :runtime_version,
       :vpc_config,
       :visual_reference,
-      :tags)
+      :tags,
+      :artifact_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -188,7 +261,7 @@ module Aws::Synthetics
     #   If you input your canary script directly into the canary instead of
     #   referring to an S3 location, the value of this parameter is the
     #   base64-encoded contents of the .zip file that contains the script.
-    #   It can be up to 5 MB.
+    #   It must be smaller than 256 Kb.
     #   @return [String]
     #
     # @!attribute [rw] handler
@@ -628,6 +701,12 @@ module Aws::Synthetics
     #         tags: {
     #           "TagKey" => "TagValue",
     #         },
+    #         artifact_config: {
+    #           s3_encryption: {
+    #             encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #             kms_key_arn: "KmsKeyArn",
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] name
@@ -731,6 +810,12 @@ module Aws::Synthetics
     #   tag values.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #   @return [Types::ArtifactConfigInput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanaryRequest AWS API Documentation
     #
     class CreateCanaryRequest < Struct.new(
@@ -744,7 +829,8 @@ module Aws::Synthetics
       :failure_retention_period_in_days,
       :runtime_version,
       :vpc_config,
-      :tags)
+      :tags,
+      :artifact_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1124,6 +1210,47 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # A structure that contains the configuration of encryption-at-rest
+    # settings for canary artifacts that the canary uploads to Amazon S3.
+    #
+    # For more information, see [Encrypting canary artifacts][1]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html
+    #
+    # @note When making an API call, you may pass S3EncryptionConfig
+    #   data as a hash:
+    #
+    #       {
+    #         encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #         kms_key_arn: "KmsKeyArn",
+    #       }
+    #
+    # @!attribute [rw] encryption_mode
+    #   The encryption method to use for artifacts created by this canary.
+    #   Specify `SSE_S3` to use server-side encryption (SSE) with an Amazon
+    #   S3-managed key. Specify `SSE-KMS` to use server-side encryption with
+    #   a customer-managed KMS key.
+    #
+    #   If you omit this parameter, an Amazon Web Services-managed KMS key
+    #   is used.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_arn
+    #   The ARN of the customer-managed KMS key to use, if you specify
+    #   `SSE-KMS` for `EncryptionMode`
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/S3EncryptionConfig AWS API Documentation
+    #
+    class S3EncryptionConfig < Struct.new(
+      :encryption_mode,
+      :kms_key_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StartCanaryRequest
     #   data as a hash:
     #
@@ -1287,6 +1414,13 @@ module Aws::Synthetics
     #           ],
     #           base_canary_run_id: "String", # required
     #         },
+    #         artifact_s3_location: "String",
+    #         artifact_config: {
+    #           s3_encryption: {
+    #             encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #             kms_key_arn: "KmsKeyArn",
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] name
@@ -1368,8 +1502,34 @@ module Aws::Synthetics
     #   @return [Types::VpcConfigInput]
     #
     # @!attribute [rw] visual_reference
+    #   Defines the screenshots to use as the baseline for comparisons
+    #   during visual monitoring comparisons during future runs of this
+    #   canary. If you omit this parameter, no changes are made to any
+    #   baseline screenshots that the canary might be using already.
+    #
+    #   Visual monitoring is supported only on canaries running the
+    #   **syn-puppeteer-node-3.2** runtime or later. For more information,
+    #   see [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
     #   @return [Types::VisualReferenceInput]
     #
+    # @!attribute [rw] artifact_s3_location
+    #   The location in Amazon S3 where Synthetics stores artifacts from the
+    #   test runs of this canary. Artifacts include the log file,
+    #   screenshots, and HAR files. The name of the S3 bucket can't include
+    #   a period (.).
+    #   @return [String]
+    #
+    # @!attribute [rw] artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #   @return [Types::ArtifactConfigInput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
     #
     class UpdateCanaryRequest < Struct.new(
@@ -1382,7 +1542,9 @@ module Aws::Synthetics
       :success_retention_period_in_days,
       :failure_retention_period_in_days,
       :vpc_config,
-      :visual_reference)
+      :visual_reference,
+      :artifact_s3_location,
+      :artifact_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1404,6 +1566,19 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # An object that specifies what screenshots to use as a baseline for
+    # visual monitoring by this canary, and optionally the parts of the
+    # screenshots to ignore during the visual monitoring comparison.
+    #
+    # Visual monitoring is supported only on canaries running the
+    # **syn-puppeteer-node-3.2** runtime or later. For more information, see
+    # [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
+    # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
+    #
     # @note When making an API call, you may pass VisualReferenceInput
     #   data as a hash:
     #
@@ -1418,9 +1593,23 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] base_screenshots
+    #   An array of screenshots that will be used as the baseline for visual
+    #   monitoring in future runs of this canary. If there is a screenshot
+    #   that you don't want to be used for visual monitoring, remove it
+    #   from this array.
     #   @return [Array<Types::BaseScreenshot>]
     #
     # @!attribute [rw] base_canary_run_id
+    #   Specifies which canary run to use the screenshots from as the
+    #   baseline for future visual monitoring with this canary. Valid values
+    #   are `nextrun` to use the screenshots from the next run after this
+    #   update is made, `lastrun` to use the screenshots from the most
+    #   recent run before this update was made, or the value of `Id` in the
+    #   [ CanaryRun][1] from any past run of this canary.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation
@@ -1432,10 +1621,23 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # If this canary performs visual monitoring by comparing screenshots,
+    # this structure contains the ID of the canary run that is used as the
+    # baseline for screenshots, and the coordinates of any parts of those
+    # screenshots that are ignored during visual monitoring comparison.
+    #
+    # Visual monitoring is supported only on canaries running the
+    # **syn-puppeteer-node-3.2** runtime or later.
+    #
     # @!attribute [rw] base_screenshots
+    #   An array of screenshots that are used as the baseline for
+    #   comparisons during visual monitoring.
     #   @return [Array<Types::BaseScreenshot>]
     #
     # @!attribute [rw] base_canary_run_id
+    #   The ID of the canary run that produced the screenshots that are used
+    #   as the baseline for visual monitoring comparisons during future runs
+    #   of this canary.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation

data/lib/aws-sdk-synthetics.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-synthetics/customizations'
 # @!group service
 module Aws::Synthetics
 
-  GEM_VERSION = '1.14.0'
+  GEM_VERSION = '1.18.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.118.0
+        version: 3.120.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.118.0
+        version: 3.120.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="