aws-sdk-signer 1.17.0 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 953735d4dc87e531a6e8d7c5d9b9094146ccb650
-  data.tar.gz: acc9ed91d1cd916efd23b4db8159641e84f78a0e
+SHA256:
+  metadata.gz: 804ae10b50f3de1c3aa32f38a6e00d5908b601f69b67107a975038b797c5e311
+  data.tar.gz: fc54fd28ebb16ff6fb136a7c48298dd5d199d6d89db60a7986f3eb2c563c0237
 SHA512:
-  metadata.gz: da645be34a7f44f48f48ed1a18337636c1dc5e19f61e659856270f3562f8a3a7fca3653eb99ea88c896c080ef819e48f9931983d08ad326e48c130a283bdca7b
-  data.tar.gz: 87209f5206f2084845df34270d5d34df61450b8137f18d63760c1537bbd1e636593f7a9b711511bf1d2a555d3cf1a8009c306608d95ae6c0d33b825155ec8401
+  metadata.gz: e34e20fa124fd4a76db620229eeda49c8ef5f870eb255b1691f6c05cfc4ec599b1b10282ee45a801e34c3a4f59497ef3dbfeb28f050651a1d77b0705e73e8c11
+  data.tar.gz: 759910c1f7567801fffb2a1db108968deb74d0b03b0a6b3992cab8cbee5ebeffd5abe162a1d203bf839d13615f2a04d0392e3cec48fa1a553344a6982f085305

data/lib/aws-sdk-signer.rb

@@ -25,17 +25,20 @@ require_relative 'aws-sdk-signer/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     signer = Aws::Signer::Client.new
+#     resp = signer.cancel_signing_profile(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS Signer all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Signer are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::Signer::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS Signer API errors
 #     end
 #
 # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-signer/customizations'
 # @service
 module Aws::Signer
 
-  GEM_VERSION = '1.17.0'
+  GEM_VERSION = '1.22.1'
 
 end

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

@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:signer)
 
 module Aws::Signer
+  # An API client for Signer.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::Signer::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::Signer
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -93,7 +107,7 @@ module Aws::Signer
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::Signer
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +152,10 @@ module Aws::Signer
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::Signer
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::Signer
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +190,29 @@ module Aws::Signer
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +220,30 @@ module Aws::Signer
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -209,16 +266,15 @@ module Aws::Signer
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -227,7 +283,7 @@ module Aws::Signer
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -319,6 +375,7 @@ module Aws::Signer
     #   resp.profile_name #=> String
     #   resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
     #   resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
+    #   resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
     #   resp.signing_parameters #=> Hash
     #   resp.signing_parameters["SigningParameterKey"] #=> String
     #   resp.created_at #=> Time
@@ -329,6 +386,11 @@ module Aws::Signer
     #   resp.signed_object.s3.bucket_name #=> String
     #   resp.signed_object.s3.key #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * successful_signing_job
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJob AWS API Documentation
     #
     # @overload describe_signing_job(params = {})
@@ -374,8 +436,8 @@ module Aws::Signer
     #   resp.signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
     #   resp.signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
     #   resp.signing_image_format.supported_formats #=> Array
-    #   resp.signing_image_format.supported_formats[0] #=> String, one of "JSON"
-    #   resp.signing_image_format.default_format #=> String, one of "JSON"
+    #   resp.signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
+    #   resp.signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
     #   resp.max_size_in_mb #=> Integer
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatform AWS API Documentation
@@ -416,6 +478,7 @@ module Aws::Signer
     #   resp.platform_id #=> String
     #   resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
     #   resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
+    #   resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
     #   resp.signing_parameters #=> Hash
     #   resp.signing_parameters["SigningParameterKey"] #=> String
     #   resp.status #=> String, one of "Active", "Canceled"
@@ -469,6 +532,8 @@ module Aws::Signer
     #   * {Types::ListSigningJobsResponse#jobs #jobs} => Array&lt;Types::SigningJob&gt;
     #   * {Types::ListSigningJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_signing_jobs({
@@ -533,6 +598,8 @@ module Aws::Signer
     #   * {Types::ListSigningPlatformsResponse#platforms #platforms} => Array&lt;Types::SigningPlatform&gt;
     #   * {Types::ListSigningPlatformsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_signing_platforms({
@@ -558,8 +625,8 @@ module Aws::Signer
     #   resp.platforms[0].signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
     #   resp.platforms[0].signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
     #   resp.platforms[0].signing_image_format.supported_formats #=> Array
-    #   resp.platforms[0].signing_image_format.supported_formats[0] #=> String, one of "JSON"
-    #   resp.platforms[0].signing_image_format.default_format #=> String, one of "JSON"
+    #   resp.platforms[0].signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
+    #   resp.platforms[0].signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
     #   resp.platforms[0].max_size_in_mb #=> Integer
     #   resp.next_token #=> String
     #
@@ -598,6 +665,8 @@ module Aws::Signer
     #   * {Types::ListSigningProfilesResponse#profiles #profiles} => Array&lt;Types::SigningProfile&gt;
     #   * {Types::ListSigningProfilesResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_signing_profiles({
@@ -675,7 +744,7 @@ module Aws::Signer
     #   with the new signing profile.
     #
     # @option params [required, String] :platform_id
-    #   The ID of the signing profile to be created.
+    #   The ID of the signing platform to be created.
     #
     # @option params [Types::SigningPlatformOverrides] :overrides
     #   A subfield of `platform`. This specifies any different configuration
@@ -687,7 +756,7 @@ module Aws::Signer
     #   that you want to use during signing.
     #
     # @option params [Hash<String,String>] :tags
-    #   Tags to be associated with the signing profile being created.
+    #   Tags to be associated with the signing profile that is being created.
     #
     # @return [Types::PutSigningProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -706,6 +775,7 @@ module Aws::Signer
     #         encryption_algorithm: "RSA", # accepts RSA, ECDSA
     #         hash_algorithm: "SHA1", # accepts SHA1, SHA256
     #       },
+    #       signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
     #     },
     #     signing_parameters: {
     #       "SigningParameterKey" => "SigningParameterValue",
@@ -814,12 +884,12 @@ module Aws::Signer
 
     # Adds one or more tags to a signing profile. Tags are labels that you
     # can use to identify and organize your AWS resources. Each tag consists
-    # of a key and an optional value. You specify the signing profile using
-    # its Amazon Resource Name (ARN). You specify the tag by using a
-    # key-value pair.
+    # of a key and an optional value. To specify the signing profile, use
+    # its Amazon Resource Name (ARN). To specify the tag, use a key-value
+    # pair.
     #
     # @option params [required, String] :resource_arn
-    #   Amazon Resource Name (ARN) for the signing profile.
+    #   The Amazon Resource Name (ARN) for the signing profile.
     #
     # @option params [required, Hash<String,String>] :tags
     #   One or more tags to be associated with the signing profile.
@@ -844,14 +914,14 @@ module Aws::Signer
       req.send_request(options)
     end
 
-    # Remove one or more tags from a signing profile. Specify a list of tag
-    # keys to remove the tags.
+    # Removes one or more tags from a signing profile. To remove the tags,
+    # specify a list of tag keys.
     #
     # @option params [required, String] :resource_arn
-    #   Amazon Resource Name (ARN) for the signing profile .
+    #   The Amazon Resource Name (ARN) for the signing profile.
     #
     # @option params [required, Array<String>] :tag_keys
-    #   A list of tag keys to be removed from the signing profile .
+    #   A list of tag keys to be removed from the signing profile.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -884,7 +954,7 @@ module Aws::Signer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-signer'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.22.1'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -950,9 +1020,9 @@ module Aws::Signer
     # The following table lists the valid waiter names, the operations they call,
     # and the default `:delay` and `:max_attempts` values.
     #
-    # | waiter_name            | params                  | :delay   | :max_attempts |
-    # | ---------------------- | ----------------------- | -------- | ------------- |
-    # | successful_signing_job | {#describe_signing_job} | 20       | 25            |
+    # | waiter_name            | params                        | :delay   | :max_attempts |
+    # | ---------------------- | ----------------------------- | -------- | ------------- |
+    # | successful_signing_job | {Client#describe_signing_job} | 20       | 25            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

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

@@ -281,6 +281,7 @@ module Aws::Signer
     SigningPlatform.struct_class = Types::SigningPlatform
 
     SigningPlatformOverrides.add_member(:signing_configuration, Shapes::ShapeRef.new(shape: SigningConfigurationOverrides, location_name: "signingConfiguration"))
+    SigningPlatformOverrides.add_member(:signing_image_format, Shapes::ShapeRef.new(shape: ImageFormat, location_name: "signingImageFormat"))
     SigningPlatformOverrides.struct_class = Types::SigningPlatformOverrides
 
     SigningPlatforms.member = Shapes::ShapeRef.new(shape: SigningPlatform)

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

@@ -6,6 +6,35 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Signer
+
+  # When Signer returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Signer::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Signer errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Signer::Errors::ServiceError
+  #       # rescues all Signer API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {AccessDeniedException}
+  # * {BadRequestException}
+  # * {InternalServiceErrorException}
+  # * {NotFoundException}
+  # * {ResourceNotFoundException}
+  # * {ThrottlingException}
+  # * {ValidationException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +52,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class BadRequestException < ServiceError
@@ -39,7 +67,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceErrorException < ServiceError
@@ -55,7 +82,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class NotFoundException < ServiceError
@@ -71,7 +97,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -87,7 +112,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
@@ -103,7 +127,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
     class ValidationException < ServiceError
@@ -119,7 +142,6 @@ module Aws::Signer
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Signer
+
   class Resource
 
     # @param options ({})

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

@@ -80,7 +80,7 @@ module Aws::Signer
     #   @return [Types::Source]
     #
     # @!attribute [rw] signing_material
-    #   Amazon Resource Name (ARN) of your code signing certificate.
+    #   The Amazon Resource Name (ARN) of your code signing certificate.
     #   @return [Types::SigningMaterial]
     #
     # @!attribute [rw] platform_id
@@ -586,6 +586,7 @@ module Aws::Signer
     #             encryption_algorithm: "RSA", # accepts RSA, ECDSA
     #             hash_algorithm: "SHA1", # accepts SHA1, SHA256
     #           },
+    #           signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
     #         },
     #         signing_parameters: {
     #           "SigningParameterKey" => "SigningParameterValue",
@@ -605,7 +606,7 @@ module Aws::Signer
     #   @return [Types::SigningMaterial]
     #
     # @!attribute [rw] platform_id
-    #   The ID of the signing profile to be created.
+    #   The ID of the signing platform to be created.
     #   @return [String]
     #
     # @!attribute [rw] overrides
@@ -620,7 +621,8 @@ module Aws::Signer
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] tags
-    #   Tags to be associated with the signing profile being created.
+    #   Tags to be associated with the signing profile that is being
+    #   created.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileRequest AWS API Documentation
@@ -760,7 +762,7 @@ module Aws::Signer
     #   @return [Types::EncryptionAlgorithmOptions]
     #
     # @!attribute [rw] hash_algorithm_options
-    #   The hash algorithm options that are available for a a code signing
+    #   The hash algorithm options that are available for a code signing
     #   job.
     #   @return [Types::HashAlgorithmOptions]
     #
@@ -804,11 +806,11 @@ module Aws::Signer
     # The image format of a code signing platform or profile.
     #
     # @!attribute [rw] supported_formats
-    #   The supported formats of a code signing signing image.
+    #   The supported formats of a code signing image.
     #   @return [Array<String>]
     #
     # @!attribute [rw] default_format
-    #   The default format of a code signing signing image.
+    #   The default format of a code signing image.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningImageFormat AWS API Documentation
@@ -882,7 +884,7 @@ module Aws::Signer
     end
 
     # Contains information about the signing configurations and parameters
-    # that is used to perform a code signing job.
+    # that are used to perform a code signing job.
     #
     # @!attribute [rw] platform_id
     #   The ID of a code signing; platform.
@@ -944,6 +946,7 @@ module Aws::Signer
     #           encryption_algorithm: "RSA", # accepts RSA, ECDSA
     #           hash_algorithm: "SHA1", # accepts SHA1, SHA256
     #         },
+    #         signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
     #       }
     #
     # @!attribute [rw] signing_configuration
@@ -951,10 +954,20 @@ module Aws::Signer
     #   hash algorithm of a signing job.
     #   @return [Types::SigningConfigurationOverrides]
     #
+    # @!attribute [rw] signing_image_format
+    #   A signed image is a JSON object. When overriding the default signing
+    #   platform configuration, a customer can select either of two signing
+    #   formats, `JSONEmbedded` or `JSONDetached`. (A third format value,
+    #   `JSON`, is reserved for future use.) With `JSONEmbedded`, the
+    #   signing image has the payload embedded in it. With `JSONDetached`,
+    #   the payload is not be embedded in the signing image.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatformOverrides AWS API Documentation
     #
     class SigningPlatformOverrides < Struct.new(
-      :signing_configuration)
+      :signing_configuration,
+      :signing_image_format)
       include Aws::Structure
     end
 
@@ -983,7 +996,7 @@ module Aws::Signer
     #   @return [String]
     #
     # @!attribute [rw] arn
-    #   Amazon Resource Name (ARN) for the signing profile.
+    #   The Amazon Resource Name (ARN) for the signing profile.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -1104,7 +1117,7 @@ module Aws::Signer
     #       }
     #
     # @!attribute [rw] resource_arn
-    #   Amazon Resource Name (ARN) for the signing profile.
+    #   The Amazon Resource Name (ARN) for the signing profile.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -1144,11 +1157,11 @@ module Aws::Signer
     #       }
     #
     # @!attribute [rw] resource_arn
-    #   Amazon Resource Name (ARN) for the signing profile .
+    #   The Amazon Resource Name (ARN) for the signing profile.
     #   @return [String]
     #
     # @!attribute [rw] tag_keys
-    #   A list of tag keys to be removed from the signing profile .
+    #   A list of tag keys to be removed from the signing profile.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/UntagResourceRequest AWS API Documentation

data/lib/aws-sdk-signer/waiters.rb

@@ -8,6 +8,67 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::Signer
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name            | params                        | :delay   | :max_attempts |
+  # | ---------------------- | ----------------------------- | -------- | ------------- |
+  # | successful_signing_job | {Client#describe_signing_job} | 20       | 25            |
+  #
   module Waiters
 
     class SuccessfulSigningJob

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-signer
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.22.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-06-11 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.71.0
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - signer