aws-sdk-signer 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 953735d4dc87e531a6e8d7c5d9b9094146ccb650
-  data.tar.gz: acc9ed91d1cd916efd23b4db8159641e84f78a0e
+  metadata.gz: acb9107d256cc32071eb567f83bf13e5d9d03918
+  data.tar.gz: 8d58d73814862e42f449a936584bb821fe28c2b0
 SHA512:
-  metadata.gz: da645be34a7f44f48f48ed1a18337636c1dc5e19f61e659856270f3562f8a3a7fca3653eb99ea88c896c080ef819e48f9931983d08ad326e48c130a283bdca7b
-  data.tar.gz: 87209f5206f2084845df34270d5d34df61450b8137f18d63760c1537bbd1e636593f7a9b711511bf1d2a555d3cf1a8009c306608d95ae6c0d33b825155ec8401
+  metadata.gz: 358de6e09e1b39715a2a396857b9f1ad6eb015697213d94ad232d90acbc9bdd6fd8f86eb3523d9d604271a50b18c1ef25bd6996beebc6ab1ecc28dda0f4cf773
+  data.tar.gz: c6f8eac8a0738e5e410e8b83d1dbad52933fa661a4bc60b32dbcbf3b4de12c13b15afdfbae64677fb5e139fdf0a599121340c1f9a036b0f4faecd1c9dd68c390

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.18.0'
 
 end

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

@@ -30,6 +30,16 @@ 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
@@ -209,16 +219,16 @@ 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}.
+    #     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.
     #
@@ -227,7 +237,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 yielded by {#session_for}.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -319,6 +329,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
@@ -374,8 +385,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 +427,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"
@@ -558,8 +570,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
     #
@@ -675,7 +687,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 +699,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 +718,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 +827,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 +857,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 +897,7 @@ module Aws::Signer
         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
 

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,39 @@
 # 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, including:
+  # *
+  # * #params - The request params
+  # * #operation_name - Name of the API operation invoked
+  # * #http_request
+  # * #http_response
+  # * etc ...
+  #
+  # 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

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

@@ -6,6 +6,13 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Signer
+  # This class provides a resource oriented interface for Signer.
+  # To create a resource object:
+  #     resource = Aws::Signer::Resource.new(region: 'us-west-2')
+  # You can supply a client object with custom configuration that will be used for all resource operations.
+  # If you do not pass +:client+, a default client will be constructed.
+  #     client = Aws::Signer::Client.new(region: 'us-west-2')
+  #     resource = Aws::Signer::Resource.new(client: client)
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-signer
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core