client.rb in aws-sdk-signer-1.18.0

- old
+ new

@@ -28,10 +28,20 @@
 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}[https://docs.aws.amazon.com/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
 
     @identifier = :signer
@@ -207,29 +217,29 @@
     #
     #   @option options [URI::HTTP,String] :http_proxy A proxy to send
     #     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}.
+    #     per-request on the session yielded by {#session_for}.
     #
     #   @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.
     #
     #   @option options [Float] :http_continue_timeout (1) The number of
     #     seconds to wait for a 100-continue response before sending the
     #     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 yielded by {#session_for}.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
     #
     #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
@@ -317,10 +327,11 @@
     #   resp.signing_material.certificate_arn #=> String
     #   resp.platform_id #=> String
     #   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
     #   resp.completed_at #=> Time
     #   resp.requested_by #=> String
@@ -372,12 +383,12 @@
     #   resp.signing_configuration.encryption_algorithm_options.default_value #=> String, one of "RSA", "ECDSA"
     #   resp.signing_configuration.hash_algorithm_options.allowed_values #=> Array
     #   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
     #
     # @overload get_signing_platform(params = {})
@@ -414,10 +425,11 @@
     #   resp.profile_name #=> String
     #   resp.signing_material.certificate_arn #=> String
     #   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"
     #   resp.arn #=> String
     #   resp.tags #=> Hash
@@ -556,12 +568,12 @@
     #   resp.platforms[0].signing_configuration.encryption_algorithm_options.default_value #=> String, one of "RSA", "ECDSA"
     #   resp.platforms[0].signing_configuration.hash_algorithm_options.allowed_values #=> Array
     #   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
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatforms AWS API Documentation
     #
@@ -673,11 +685,11 @@
     # @option params [required, Types::SigningMaterial] :signing_material
     #   The AWS Certificate Manager certificate that will be used to sign code
     #   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
     #   options that you want to apply to the chosen platform (such as a
     #   different `hash-algorithm` or `signing-algorithm`).
@@ -685,11 +697,11 @@
     # @option params [Hash<String,String>] :signing_parameters
     #   Map of key-value pairs for signing. These can include any information
     #   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:
     #
     #   * {Types::PutSigningProfileResponse#arn #arn} => String
     #
@@ -704,10 +716,11 @@
     #     overrides: {
     #       signing_configuration: {
     #         encryption_algorithm: "RSA", # accepts RSA, ECDSA
     #         hash_algorithm: "SHA1", # accepts SHA1, SHA256
     #       },
+    #       signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
     #     },
     #     signing_parameters: {
     #       "SigningParameterKey" => "SigningParameterValue",
     #     },
     #     tags: {
@@ -812,16 +825,16 @@
       req.send_request(options)
     end
 
     # 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.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -842,18 +855,18 @@
     def tag_resource(params = {}, options = {})
       req = build_request(:tag_resource, params)
       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}.
     #
     # @example Request syntax with placeholder values
     #
@@ -882,10 +895,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-signer'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # Polls an API operation until a resource enters a desired state.
     #