aws-sdk-synthetics 1.10.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77ffc9e6b30e991c4bfbc3e443ba8ccba5d84ca5d5398ad0f633ea7a492ccd1
-  data.tar.gz: 6c519143fc3b952b3888e31d110101b82d96703ca6efe9b2a8e19af8d8289a91
+  metadata.gz: 16a3cf45c70183d8debdb6f6780ec8e3c04738f891681c0f10b63af9c2f057b8
+  data.tar.gz: 1e23c947e3f5d190235033230aaafde009e2354230da71eab810296fa77c29b4
 SHA512:
-  metadata.gz: 91cd051382515976415efec63dc4f7bed1e97e02e31139a16c4cb73c0e39e2799731ed0bf4506a015dd439fd32fe0f811f80e7a7b75017c078df241f597d99fa
-  data.tar.gz: c582d6a2f28507e2789ed1107af9b65ca0b5c552fbb12e9aa572564054c103c5478343ab135f8f797be6e1ea04673170fc092b4221ef6d939f88e0c31de531ce
+  metadata.gz: f7afc6890593033d2e0315a18b2afba827d6cb387d6fee6520d35d95d8bb87f4e6519847886f56f4875f048b87cec48e002bd4cbb6228005171f097f823c5e94
+  data.tar.gz: 140c09a86cb9f4c1fc5ae88431e2d3f5d47e64b2ba234fc3bde7e0939b96d403d4a048f9f74e050a706647745d9a585373cfea0e4a3cd1b5827eabf2ff94ea44

data/CHANGELOG.md

@@ -0,0 +1,83 @@
+Unreleased Changes
+------------------
+
+1.14.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.13.0 (2021-07-26)
+------------------
+
+* Feature - CloudWatch Synthetics now supports visual testing in its canaries.
+
+1.12.0 (2021-03-10)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.11.0 (2021-02-02)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.10.0 (2020-11-16)
+------------------
+
+* Feature - AWS Synthetics now supports Environment Variables  to assign runtime parameters in the canary scripts.
+
+1.9.0 (2020-09-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.8.0 (2020-09-24)
+------------------
+
+* Feature - AWS Synthetics now supports AWS X-Ray Active Tracing feature. RunConfig is now an optional parameter with timeout updated from (60 - 900 seconds) to (3 - 840 seconds).
+
+1.7.0 (2020-09-15)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.6.0 (2020-08-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.5.0 (2020-06-23)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.4.1 (2020-06-11)
+------------------
+
+* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
+
+1.4.0 (2020-06-10)
+------------------
+
+* Issue - This version has been yanked. (#2327).
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.3.0 (2020-05-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.2.0 (2020-05-21)
+------------------
+
+* Feature - AWS CloudWatch Synthetics now supports configuration of allocated memory for a canary.
+
+1.1.0 (2020-05-07)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.0.0 (2020-04-20)
+------------------
+
+* Feature - Initial release of `aws-sdk-synthetics`.

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/VERSION

@@ -0,0 +1 @@
+1.14.0

data/lib/aws-sdk-synthetics.rb

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-synthetics/customizations'
 # @!group service
 module Aws::Synthetics
 
-  GEM_VERSION = '1.10.0'
+  GEM_VERSION = '1.14.0'
 
 end

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -375,7 +375,7 @@ module Aws::Synthetics
     # @option params [required, 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.
+    #   and HAR files. The name of the S3 bucket can't include a period (.).
     #
     # @option params [required, String] :execution_role_arn
     #   The ARN of the IAM role to be used to run the canary. This role must
@@ -511,6 +511,11 @@ module Aws::Synthetics
     #   resp.canary.vpc_config.subnet_ids[0] #=> String
     #   resp.canary.vpc_config.security_group_ids #=> Array
     #   resp.canary.vpc_config.security_group_ids[0] #=> String
+    #   resp.canary.visual_reference.base_screenshots #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #
@@ -637,6 +642,11 @@ module Aws::Synthetics
     #   resp.canaries[0].vpc_config.subnet_ids[0] #=> String
     #   resp.canaries[0].vpc_config.security_group_ids #=> Array
     #   resp.canaries[0].vpc_config.security_group_ids[0] #=> String
+    #   resp.canaries[0].visual_reference.base_screenshots #=> Array
+    #   resp.canaries[0].visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canaries[0].visual_reference.base_canary_run_id #=> String
     #   resp.canaries[0].tags #=> Hash
     #   resp.canaries[0].tags["TagKey"] #=> String
     #   resp.next_token #=> String
@@ -799,6 +809,11 @@ module Aws::Synthetics
     #   resp.canary.vpc_config.subnet_ids[0] #=> String
     #   resp.canary.vpc_config.security_group_ids #=> Array
     #   resp.canary.vpc_config.security_group_ids[0] #=> String
+    #   resp.canary.visual_reference.base_screenshots #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #
@@ -968,8 +983,8 @@ module Aws::Synthetics
     # use them to scope user permissions, by granting a user permission to
     # access or change only resources with certain tag values.
     #
-    # Tags don't have any semantic meaning to AWS and are interpreted
-    # strictly as strings of characters.
+    # Tags don't have any semantic meaning to Amazon Web Services and are
+    # interpreted strictly as strings of characters.
     #
     # You can use the `TagResource` action with a canary that already has
     # tags. If you specify a new tag key for the alarm, this tag is appended
@@ -1116,6 +1131,8 @@ module Aws::Synthetics
     #
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #
+    # @option params [Types::VisualReferenceInput] :visual_reference
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -1149,6 +1166,15 @@ module Aws::Synthetics
     #       subnet_ids: ["SubnetId"],
     #       security_group_ids: ["SecurityGroupId"],
     #     },
+    #     visual_reference: {
+    #       base_screenshots: [
+    #         {
+    #           screenshot_name: "String", # required
+    #           ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #         },
+    #       ],
+    #       base_canary_run_id: "String", # required
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
@@ -1173,7 +1199,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -13,6 +13,10 @@ module Aws::Synthetics
 
     include Seahorse::Model
 
+    BaseScreenshot = Shapes::StructureShape.new(name: 'BaseScreenshot')
+    BaseScreenshotConfigIgnoreCoordinate = Shapes::StringShape.new(name: 'BaseScreenshotConfigIgnoreCoordinate')
+    BaseScreenshotIgnoreCoordinates = Shapes::ListShape.new(name: 'BaseScreenshotIgnoreCoordinates')
+    BaseScreenshots = Shapes::ListShape.new(name: 'BaseScreenshots')
     Blob = Shapes::BlobShape.new(name: 'Blob')
     Canaries = Shapes::ListShape.new(name: 'Canaries')
     CanariesLastRun = Shapes::ListShape.new(name: 'CanariesLastRun')
@@ -93,10 +97,20 @@ module Aws::Synthetics
     UpdateCanaryRequest = Shapes::StructureShape.new(name: 'UpdateCanaryRequest')
     UpdateCanaryResponse = Shapes::StructureShape.new(name: 'UpdateCanaryResponse')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
+    VisualReferenceInput = Shapes::StructureShape.new(name: 'VisualReferenceInput')
+    VisualReferenceOutput = Shapes::StructureShape.new(name: 'VisualReferenceOutput')
     VpcConfigInput = Shapes::StructureShape.new(name: 'VpcConfigInput')
     VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
     VpcId = Shapes::StringShape.new(name: 'VpcId')
 
+    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
+
+    BaseScreenshotIgnoreCoordinates.member = Shapes::ShapeRef.new(shape: BaseScreenshotConfigIgnoreCoordinate)
+
+    BaseScreenshots.member = Shapes::ShapeRef.new(shape: BaseScreenshot)
+
     Canaries.member = Shapes::ShapeRef.new(shape: Canary)
 
     CanariesLastRun.member = Shapes::ShapeRef.new(shape: CanaryLastRun)
@@ -115,6 +129,7 @@ module Aws::Synthetics
     Canary.add_member(:engine_arn, Shapes::ShapeRef.new(shape: FunctionArn, location_name: "EngineArn"))
     Canary.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
     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.struct_class = Types::Canary
 
@@ -307,6 +322,7 @@ module Aws::Synthetics
     UpdateCanaryRequest.add_member(:success_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "SuccessRetentionPeriodInDays"))
     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.struct_class = Types::UpdateCanaryRequest
 
     UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
@@ -314,6 +330,14 @@ module Aws::Synthetics
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ValidationException.struct_class = Types::ValidationException
 
+    VisualReferenceInput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
+    VisualReferenceInput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "BaseCanaryRunId"))
+    VisualReferenceInput.struct_class = Types::VisualReferenceInput
+
+    VisualReferenceOutput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
+    VisualReferenceOutput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, location_name: "BaseCanaryRunId"))
+    VisualReferenceOutput.struct_class = Types::VisualReferenceOutput
+
     VpcConfigInput.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
     VpcConfigInput.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
     VpcConfigInput.struct_class = Types::VpcConfigInput

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 

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

@@ -3,13 +3,36 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Synthetics
   module Types
 
+    # @note When making an API call, you may pass BaseScreenshot
+    #   data as a hash:
+    #
+    #       {
+    #         screenshot_name: "String", # required
+    #         ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #       }
+    #
+    # @!attribute [rw] screenshot_name
+    #   @return [String]
+    #
+    # @!attribute [rw] ignore_coordinates
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BaseScreenshot AWS API Documentation
+    #
+    class BaseScreenshot < Struct.new(
+      :screenshot_name,
+      :ignore_coordinates)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This structure contains all information about one canary in your
     # account.
     #
@@ -95,6 +118,9 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #   @return [Types::VpcConfigOutput]
     #
+    # @!attribute [rw] visual_reference
+    #   @return [Types::VisualReferenceOutput]
+    #
     # @!attribute [rw] tags
     #   The list of key-value pairs that are associated with the canary.
     #   @return [Hash<String,String>]
@@ -116,6 +142,7 @@ module Aws::Synthetics
       :engine_arn,
       :runtime_version,
       :vpc_config,
+      :visual_reference,
       :tags)
       SENSITIVE = []
       include Aws::Structure
@@ -140,9 +167,8 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] s3_bucket
-    #   If your canary script is located in S3, specify the full bucket name
-    #   here. The bucket must already exist. Specify the full bucket name,
-    #   including `s3://` as the start of the bucket name.
+    #   If your canary script is located in S3, specify the bucket name
+    #   here. Do not include `s3://` as the start of the bucket name.
     #   @return [String]
     #
     # @!attribute [rw] s3_key
@@ -160,13 +186,15 @@ module Aws::Synthetics
     #
     # @!attribute [rw] zip_file
     #   If you input your canary script directly into the canary instead of
-    #   referring to an S3 location, the value of this parameter is the .zip
-    #   file that contains the script. It can be up to 5 MB.
+    #   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.
     #   @return [String]
     #
     # @!attribute [rw] handler
     #   The entry point to use for the source code when running the canary.
-    #   This value must end with the string `.handler`.
+    #   This value must end with the string `.handler`. The string is
+    #   limited to 29 characters or fewer.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation
@@ -286,12 +314,12 @@ module Aws::Synthetics
     #   @return [Integer]
     #
     # @!attribute [rw] active_tracing
-    #   Specifies whether this canary is to use active AWS X-Ray tracing
-    #   when it runs. Active tracing enables this canary run to be displayed
-    #   in the ServiceLens and X-Ray service maps even if the canary does
-    #   not hit an endpoint that has X-ray tracing enabled. Using X-Ray
-    #   tracing incurs charges. For more information, see [ Canaries and
-    #   X-Ray tracing][1].
+    #   Specifies whether this canary is to use active X-Ray tracing when it
+    #   runs. Active tracing enables this canary run to be displayed in the
+    #   ServiceLens and X-Ray service maps even if the canary does not hit
+    #   an endpoint that has X-Ray tracing enabled. Using X-Ray tracing
+    #   incurs charges. For more information, see [ Canaries and X-Ray
+    #   tracing][1].
     #
     #   You can enable active tracing only for canaries that use version
     #   `syn-nodejs-2.0` or later for their canary runtime.
@@ -341,7 +369,7 @@ module Aws::Synthetics
     #   @return [Integer]
     #
     # @!attribute [rw] active_tracing
-    #   Displays whether this canary run used active AWS X-Ray tracing.
+    #   Displays whether this canary run used active X-Ray tracing.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigOutput AWS API Documentation
@@ -413,9 +441,11 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] expression
-    #   A rate expression that defines how often the canary is to run. The
-    #   syntax is `rate(number unit)`. *unit* can be `minute`, `minutes`, or
-    #   `hour`.
+    #   A `rate` expression or a `cron` expression that defines how often
+    #   the canary is to run.
+    #
+    #   For a rate expression, The syntax is `rate(number unit)`. *unit* can
+    #   be `minute`, `minutes`, or `hour`.
     #
     #   For example, `rate(1 minute)` runs the canary once a minute,
     #   `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
@@ -424,6 +454,15 @@ module Aws::Synthetics
     #
     #   Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
     #   that causes the canary to run only once when it is started.
+    #
+    #   Use `cron(expression)` to specify a cron expression. You can't
+    #   schedule a canary to wait for more than a year before running. For
+    #   information about the syntax for cron expressions, see [ Scheduling
+    #   canary runs using cron][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
     #   @return [String]
     #
     # @!attribute [rw] duration_in_seconds
@@ -446,16 +485,27 @@ module Aws::Synthetics
     # according to the schedule in the `Expression` value.
     #
     # @!attribute [rw] expression
-    #   A rate expression that defines how often the canary is to run. The
-    #   syntax is `rate(number unit)`. *unit* can be `minute`, `minutes`, or
-    #   `hour`.
+    #   A `rate` expression or a `cron` expression that defines how often
+    #   the canary is to run.
+    #
+    #   For a rate expression, The syntax is `rate(number unit)`. *unit* can
+    #   be `minute`, `minutes`, or `hour`.
     #
     #   For example, `rate(1 minute)` runs the canary once a minute,
     #   `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
-    #   runs it once every hour.
+    #   runs it once every hour. You can specify a frequency between `rate(1
+    #   minute)` and `rate(1 hour)`.
     #
     #   Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
     #   that causes the canary to run only once when it is started.
+    #
+    #   Use `cron(expression)` to specify a cron expression. For information
+    #   about the syntax for cron expressions, see [ Scheduling canary runs
+    #   using cron][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
     #   @return [String]
     #
     # @!attribute [rw] duration_in_seconds
@@ -604,7 +654,8 @@ module Aws::Synthetics
     # @!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.
+    #   screenshots, and HAR files. The name of the S3 bucket can't include
+    #   a period (.).
     #   @return [String]
     #
     # @!attribute [rw] execution_role_arn
@@ -1227,6 +1278,15 @@ module Aws::Synthetics
     #           subnet_ids: ["SubnetId"],
     #           security_group_ids: ["SecurityGroupId"],
     #         },
+    #         visual_reference: {
+    #           base_screenshots: [
+    #             {
+    #               screenshot_name: "String", # required
+    #               ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #             },
+    #           ],
+    #           base_canary_run_id: "String", # required
+    #         },
     #       }
     #
     # @!attribute [rw] name
@@ -1307,6 +1367,9 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #   @return [Types::VpcConfigInput]
     #
+    # @!attribute [rw] visual_reference
+    #   @return [Types::VisualReferenceInput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
     #
     class UpdateCanaryRequest < Struct.new(
@@ -1318,7 +1381,8 @@ module Aws::Synthetics
       :run_config,
       :success_retention_period_in_days,
       :failure_retention_period_in_days,
-      :vpc_config)
+      :vpc_config,
+      :visual_reference)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1340,6 +1404,49 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass VisualReferenceInput
+    #   data as a hash:
+    #
+    #       {
+    #         base_screenshots: [
+    #           {
+    #             screenshot_name: "String", # required
+    #             ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #           },
+    #         ],
+    #         base_canary_run_id: "String", # required
+    #       }
+    #
+    # @!attribute [rw] base_screenshots
+    #   @return [Array<Types::BaseScreenshot>]
+    #
+    # @!attribute [rw] base_canary_run_id
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation
+    #
+    class VisualReferenceInput < Struct.new(
+      :base_screenshots,
+      :base_canary_run_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] base_screenshots
+    #   @return [Array<Types::BaseScreenshot>]
+    #
+    # @!attribute [rw] base_canary_run_id
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation
+    #
+    class VisualReferenceOutput < Struct.new(
+      :base_screenshots,
+      :base_canary_run_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # If this canary is to test an endpoint in a VPC, this structure
     # contains information about the subnets and security groups of the VPC
     # endpoint. For more information, see [ Running a Canary in a VPC][1].

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-07-28 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.109.0
+        version: 3.118.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.109.0
+        version: 3.118.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -47,11 +47,14 @@ dependencies:
 description: Official AWS Ruby gem for Synthetics. This gem is part of the AWS SDK
   for Ruby.
 email:
-- trevrowe@amazon.com
+- aws-dr-rubygems@amazon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- VERSION
 - lib/aws-sdk-synthetics.rb
 - lib/aws-sdk-synthetics/client.rb
 - lib/aws-sdk-synthetics/client_api.rb
@@ -63,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-synthetics
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-synthetics/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -80,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Synthetics