aws-sdk-synthetics 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2345606c029e7b7f64131b83cb1284524d39ebc0bed2e246b2508597fb30922
-  data.tar.gz: 3c5d767b86bbb895425010ba6e2214dc08d86d7cc0a3706d79ca7c73b571c695
+  metadata.gz: ef6c0f77e8ee3ee6e0721111a64ddc60ef13323bda6f551719276c94140baca1
+  data.tar.gz: b865b3fb7efde95a4fb7b1a8f10651f9f4a1552e46835897ebb2a8b7485b9068
 SHA512:
-  metadata.gz: 0a7ee0dc5b09a6fa92b5d7f7c642bd5a8a59a7bac34413a1aa9e3bfff1a64350ee91868bd672b999798fdd986c56e2720278de392ae700c0cc849bcd8f550f5f
-  data.tar.gz: 4f9518b136315fea94ac8a7991e669b761fe110939ae54a12d2f1e74dcc2d1e93aa56af1c782797e1ac30ceaf09d695a897f2ec9d0b808a974c1cbd411f46568
+  metadata.gz: cf4258a8aea33367df051252fbfb49d8329f8956dc4fe56033674c80f78ecf86315c4cf36a966158a4d7e3eb7ffd0bf2ed9b1eb74d16a9b70cb8800a8794e11e
+  data.tar.gz: bbbbf3d8949b7bbe08d41fb4e268e4865e524c638989a630192a1079b6bdb2d0878f218b0e65bda459ca428505102881ba6d5f64f8fe61fb63a629ae26771df0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.24.0 (2022-02-07)
+------------------
+
+* Feature - Adding names parameters to the Describe APIs.
+
 1.23.0 (2022-02-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.23.0
+1.24.0

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

@@ -618,10 +618,21 @@ module Aws::Synthetics
     # This operation returns a list of the canaries in your account, along
     # with full details about each canary.
     #
-    # This operation does not have resource-level authorization, so if a
-    # user is able to use `DescribeCanaries`, the user can see all of the
-    # canaries in the account. A deny policy can only be used to restrict
-    # access to all canaries. It cannot be used on specific resources.
+    # This operation supports resource-level authorization using an IAM
+    # policy and the `Names` parameter. If you specify the `Names`
+    # parameter, the operation is successful only if you have authorization
+    # to view all the canaries that you specify in your request. If you do
+    # not have permission to view any of the canaries, the request fails
+    # with a 403 response.
+    #
+    # You are required to use the `Names` parameter if you are logged on to
+    # a user or role that has an IAM policy that restricts which canaries
+    # that you are allowed to view. For more information, see [ Limiting a
+    # user to viewing specific canaries][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
     #
     # @option params [String] :next_token
     #   A token that indicates that there is more data available. You can use
@@ -633,6 +644,24 @@ module Aws::Synthetics
     #   time you use the `DescribeCanaries` operation. If you omit this
     #   parameter, the default of 100 is used.
     #
+    # @option params [Array<String>] :names
+    #   Use this parameter to return only canaries that match the names that
+    #   you specify here. You can specify as many as five canary names.
+    #
+    #   If you specify this parameter, the operation is successful only if you
+    #   have authorization to view all the canaries that you specify in your
+    #   request. If you do not have permission to view any of the canaries,
+    #   the request fails with a 403 response.
+    #
+    #   You are required to use this parameter if you are logged on to a user
+    #   or role that has an IAM policy that restricts which canaries that you
+    #   are allowed to view. For more information, see [ Limiting a user to
+    #   viewing specific canaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
+    #
     # @return [Types::DescribeCanariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeCanariesResponse#canaries #canaries} => Array&lt;Types::Canary&gt;
@@ -645,6 +674,7 @@ module Aws::Synthetics
     #   resp = client.describe_canaries({
     #     next_token: "Token",
     #     max_results: 1,
+    #     names: ["CanaryName"],
     #   })
     #
     # @example Response structure
@@ -700,6 +730,22 @@ module Aws::Synthetics
     # Use this operation to see information from the most recent run of each
     # canary that you have created.
     #
+    # This operation supports resource-level authorization using an IAM
+    # policy and the `Names` parameter. If you specify the `Names`
+    # parameter, the operation is successful only if you have authorization
+    # to view all the canaries that you specify in your request. If you do
+    # not have permission to view any of the canaries, the request fails
+    # with a 403 response.
+    #
+    # You are required to use the `Names` parameter if you are logged on to
+    # a user or role that has an IAM policy that restricts which canaries
+    # that you are allowed to view. For more information, see [ Limiting a
+    # user to viewing specific canaries][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
+    #
     # @option params [String] :next_token
     #   A token that indicates that there is more data available. You can use
     #   this token in a subsequent `DescribeCanaries` operation to retrieve
@@ -710,6 +756,24 @@ module Aws::Synthetics
     #   you use the `DescribeLastRun` operation. If you omit this parameter,
     #   the default of 100 is used.
     #
+    # @option params [Array<String>] :names
+    #   Use this parameter to return only canaries that match the names that
+    #   you specify here. You can specify as many as five canary names.
+    #
+    #   If you specify this parameter, the operation is successful only if you
+    #   have authorization to view all the canaries that you specify in your
+    #   request. If you do not have permission to view any of the canaries,
+    #   the request fails with a 403 response.
+    #
+    #   You are required to use the `Names` parameter if you are logged on to
+    #   a user or role that has an IAM policy that restricts which canaries
+    #   that you are allowed to view. For more information, see [ Limiting a
+    #   user to viewing specific canaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
+    #
     # @return [Types::DescribeCanariesLastRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeCanariesLastRunResponse#canaries_last_run #canaries_last_run} => Array&lt;Types::CanaryLastRun&gt;
@@ -722,6 +786,7 @@ module Aws::Synthetics
     #   resp = client.describe_canaries_last_run({
     #     next_token: "Token",
     #     max_results: 1,
+    #     names: ["CanaryName"],
     #   })
     #
     # @example Response structure
@@ -1268,7 +1333,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -47,8 +47,10 @@ module Aws::Synthetics
     CreateCanaryResponse = Shapes::StructureShape.new(name: 'CreateCanaryResponse')
     DeleteCanaryRequest = Shapes::StructureShape.new(name: 'DeleteCanaryRequest')
     DeleteCanaryResponse = Shapes::StructureShape.new(name: 'DeleteCanaryResponse')
+    DescribeCanariesLastRunNameFilter = Shapes::ListShape.new(name: 'DescribeCanariesLastRunNameFilter')
     DescribeCanariesLastRunRequest = Shapes::StructureShape.new(name: 'DescribeCanariesLastRunRequest')
     DescribeCanariesLastRunResponse = Shapes::StructureShape.new(name: 'DescribeCanariesLastRunResponse')
+    DescribeCanariesNameFilter = Shapes::ListShape.new(name: 'DescribeCanariesNameFilter')
     DescribeCanariesRequest = Shapes::StructureShape.new(name: 'DescribeCanariesRequest')
     DescribeCanariesResponse = Shapes::StructureShape.new(name: 'DescribeCanariesResponse')
     DescribeRuntimeVersionsRequest = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsRequest')
@@ -74,6 +76,7 @@ module Aws::Synthetics
     MaxSize1024 = Shapes::IntegerShape.new(name: 'MaxSize1024')
     MaxSize3008 = Shapes::IntegerShape.new(name: 'MaxSize3008')
     NullableBoolean = Shapes::BooleanShape.new(name: 'NullableBoolean')
+    RequestEntityTooLargeException = Shapes::StructureShape.new(name: 'RequestEntityTooLargeException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
     RuntimeVersion = Shapes::StructureShape.new(name: 'RuntimeVersion')
@@ -233,16 +236,22 @@ module Aws::Synthetics
 
     DeleteCanaryResponse.struct_class = Types::DeleteCanaryResponse
 
+    DescribeCanariesLastRunNameFilter.member = Shapes::ShapeRef.new(shape: CanaryName)
+
     DescribeCanariesLastRunRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
     DescribeCanariesLastRunRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize100, location_name: "MaxResults"))
+    DescribeCanariesLastRunRequest.add_member(:names, Shapes::ShapeRef.new(shape: DescribeCanariesLastRunNameFilter, location_name: "Names"))
     DescribeCanariesLastRunRequest.struct_class = Types::DescribeCanariesLastRunRequest
 
     DescribeCanariesLastRunResponse.add_member(:canaries_last_run, Shapes::ShapeRef.new(shape: CanariesLastRun, location_name: "CanariesLastRun"))
     DescribeCanariesLastRunResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
     DescribeCanariesLastRunResponse.struct_class = Types::DescribeCanariesLastRunResponse
 
+    DescribeCanariesNameFilter.member = Shapes::ShapeRef.new(shape: CanaryName)
+
     DescribeCanariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
     DescribeCanariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxCanaryResults, location_name: "MaxResults"))
+    DescribeCanariesRequest.add_member(:names, Shapes::ShapeRef.new(shape: DescribeCanariesNameFilter, location_name: "Names"))
     DescribeCanariesRequest.struct_class = Types::DescribeCanariesRequest
 
     DescribeCanariesResponse.add_member(:canaries, Shapes::ShapeRef.new(shape: Canaries, location_name: "Canaries"))
@@ -284,6 +293,9 @@ module Aws::Synthetics
     ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
 
+    RequestEntityTooLargeException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
+    RequestEntityTooLargeException.struct_class = Types::RequestEntityTooLargeException
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
@@ -393,6 +405,7 @@ module Aws::Synthetics
         o.output = Shapes::ShapeRef.new(shape: CreateCanaryResponse)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: RequestEntityTooLargeException)
       end)
 
       api.add_operation(:delete_canary, Seahorse::Model::Operation.new.tap do |o|
@@ -549,6 +562,7 @@ module Aws::Synthetics
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: RequestEntityTooLargeException)
       end)
     end
 

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

@@ -29,6 +29,7 @@ module Aws::Synthetics
   # ## Error Classes
   # * {ConflictException}
   # * {InternalServerException}
+  # * {RequestEntityTooLargeException}
   # * {ResourceNotFoundException}
   # * {ValidationException}
   #
@@ -68,6 +69,21 @@ module Aws::Synthetics
       end
     end
 
+    class RequestEntityTooLargeException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::Synthetics::Types::RequestEntityTooLargeException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class ResourceNotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

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

@@ -261,7 +261,10 @@ 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 must be smaller than 256 Kb.
+    #   It must be smaller than 225 Kb.
+    #
+    #   For large canary scripts, we recommend that you use an S3 location
+    #   instead of inputting it directly with this parameter.
     #   @return [String]
     #
     # @!attribute [rw] handler
@@ -881,6 +884,7 @@ module Aws::Synthetics
     #       {
     #         next_token: "Token",
     #         max_results: 1,
+    #         names: ["CanaryName"],
     #       }
     #
     # @!attribute [rw] next_token
@@ -895,11 +899,31 @@ module Aws::Synthetics
     #   the default of 100 is used.
     #   @return [Integer]
     #
+    # @!attribute [rw] names
+    #   Use this parameter to return only canaries that match the names that
+    #   you specify here. You can specify as many as five canary names.
+    #
+    #   If you specify this parameter, the operation is successful only if
+    #   you have authorization to view all the canaries that you specify in
+    #   your request. If you do not have permission to view any of the
+    #   canaries, the request fails with a 403 response.
+    #
+    #   You are required to use the `Names` parameter if you are logged on
+    #   to a user or role that has an IAM policy that restricts which
+    #   canaries that you are allowed to view. For more information, see [
+    #   Limiting a user to viewing specific canaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRunRequest AWS API Documentation
     #
     class DescribeCanariesLastRunRequest < Struct.new(
       :next_token,
-      :max_results)
+      :max_results,
+      :names)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -930,6 +954,7 @@ module Aws::Synthetics
     #       {
     #         next_token: "Token",
     #         max_results: 1,
+    #         names: ["CanaryName"],
     #       }
     #
     # @!attribute [rw] next_token
@@ -944,11 +969,31 @@ module Aws::Synthetics
     #   parameter, the default of 100 is used.
     #   @return [Integer]
     #
+    # @!attribute [rw] names
+    #   Use this parameter to return only canaries that match the names that
+    #   you specify here. You can specify as many as five canary names.
+    #
+    #   If you specify this parameter, the operation is successful only if
+    #   you have authorization to view all the canaries that you specify in
+    #   your request. If you do not have permission to view any of the
+    #   canaries, the request fails with a 403 response.
+    #
+    #   You are required to use this parameter if you are logged on to a
+    #   user or role that has an IAM policy that restricts which canaries
+    #   that you are allowed to view. For more information, see [ Limiting a
+    #   user to viewing specific canaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesRequest AWS API Documentation
     #
     class DescribeCanariesRequest < Struct.new(
       :next_token,
-      :max_results)
+      :max_results,
+      :names)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1156,6 +1201,19 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # One of the input resources is larger than is allowed.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/RequestEntityTooLargeException AWS API Documentation
+    #
+    class RequestEntityTooLargeException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # One of the specified resources was not found.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-synthetics.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core