aws-sdk-signer 1.47.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26bc574cc0894055cd806c059124480424beecc922d378df1c41fa9ff0ef9aed
-  data.tar.gz: e1a07cf3ab30de2a2a0bb72603216140db3feffd5659c76320ab2344851dfca2
+  metadata.gz: 66fb8c22715eab93b7147f680159d71bf2a04f09e77656711a0d747de6958e90
+  data.tar.gz: 8afddd2315d7eb19de94e8b0286d371b204b6b6ccd2a1b0b72009fdec9974c73
 SHA512:
-  metadata.gz: d7a14e6a0a7cbaa1473f8d12d072f9656343ae58ec00b8f9ceb94b7fcabd42692b113af84599cf461e25262556afec5f00c092b8c5670ef8e3efe80d5b5509bd
-  data.tar.gz: 86f8b00f72df18219a44abd1aa91b3c53e598e1944156f4c478124065512af8d57d687fb335df4d5eacba2985bbe11adec60dd1f9ff9d586febe0515ae131eb4
+  metadata.gz: e822a922d94aba27a047d30be62d07a1c6694195b045acf675e865414fb4d2de2c536dbb109f7bc7fb5a47ce95717bf95bb3ee7707af2950ed8e5e8f5e0c7d3e
+  data.tar.gz: da2d39e7f0303b61ff164f069189c58b30699560e96010007e33ae8c5c3848f147a552841b2fd964e4b22cb03eecc545f7c893a5116cc4f2e98d464eb55122d8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.48.0 (2023-11-14)
+------------------
+
+* Feature - Documentation updates for AWS Signer
+
 1.47.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.47.0
+1.48.0

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

@@ -563,6 +563,21 @@ module Aws::Signer
     #   (signed by the parent CA) combined with a parent CA TBS hash (signed
     #   by the parent CA’s CA). Root certificates are defined as their own CA.
     #
+    #   The following example shows how to calculate a hash for this parameter
+    #   using OpenSSL commands:
+    #
+    #   `openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs`
+    #
+    #   `openssl sha384 < childCert.tbs -binary > childCertTbsHash`
+    #
+    #   `openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs`
+    #
+    #   `openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p
+    #   childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >>
+    #   certificateHash.hex`
+    #
+    #   `cat certificateHash.hex | tr -d '\n'`
+    #
     # @return [Types::GetRevocationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetRevocationStatusResponse#revoked_entities #revoked_entities} => Array&lt;String&gt;
@@ -751,12 +766,12 @@ module Aws::Signer
 
     # Lists all your signing jobs. You can use the `maxResults` parameter to
     # limit the number of signing jobs that are returned in the response. If
-    # additional jobs remain to be listed, code signing returns a
-    # `nextToken` value. Use this value in subsequent calls to
-    # `ListSigningJobs` to fetch the remaining values. You can continue
-    # calling `ListSigningJobs` with your `maxResults` parameter and with
-    # new values that code signing returns in the `nextToken` parameter
-    # until all of your signing jobs have been returned.
+    # additional jobs remain to be listed, AWS Signer returns a `nextToken`
+    # value. Use this value in subsequent calls to `ListSigningJobs` to
+    # fetch the remaining values. You can continue calling `ListSigningJobs`
+    # with your `maxResults` parameter and with new values that Signer
+    # returns in the `nextToken` parameter until all of your signing jobs
+    # have been returned.
     #
     # @option params [String] :status
     #   A status value with which to filter your results.
@@ -848,13 +863,13 @@ module Aws::Signer
       req.send_request(options)
     end
 
-    # Lists all signing platforms available in code signing that match the
-    # request parameters. If additional jobs remain to be listed, code
-    # signing returns a `nextToken` value. Use this value in subsequent
-    # calls to `ListSigningJobs` to fetch the remaining values. You can
-    # continue calling `ListSigningJobs` with your `maxResults` parameter
-    # and with new values that code signing returns in the `nextToken`
-    # parameter until all of your signing jobs have been returned.
+    # Lists all signing platforms available in AWS Signer that match the
+    # request parameters. If additional jobs remain to be listed, Signer
+    # returns a `nextToken` value. Use this value in subsequent calls to
+    # `ListSigningJobs` to fetch the remaining values. You can continue
+    # calling `ListSigningJobs` with your `maxResults` parameter and with
+    # new values that Signer returns in the `nextToken` parameter until all
+    # of your signing jobs have been returned.
     #
     # @option params [String] :category
     #   The category type of a signing platform.
@@ -923,12 +938,12 @@ module Aws::Signer
 
     # Lists all available signing profiles in your AWS account. Returns only
     # profiles with an `ACTIVE` status unless the `includeCanceled` request
-    # field is set to `true`. If additional jobs remain to be listed, code
-    # signing returns a `nextToken` value. Use this value in subsequent
-    # calls to `ListSigningJobs` to fetch the remaining values. You can
-    # continue calling `ListSigningJobs` with your `maxResults` parameter
-    # and with new values that code signing returns in the `nextToken`
-    # parameter until all of your signing jobs have been returned.
+    # field is set to `true`. If additional jobs remain to be listed, AWS
+    # Signer returns a `nextToken` value. Use this value in subsequent calls
+    # to `ListSigningJobs` to fetch the remaining values. You can continue
+    # calling `ListSigningJobs` with your `maxResults` parameter and with
+    # new values that Signer returns in the `nextToken` parameter until all
+    # of your signing jobs have been returned.
     #
     # @option params [Boolean] :include_canceled
     #   Designates whether to include profiles with the status of `CANCELED`.
@@ -1024,7 +1039,7 @@ module Aws::Signer
       req.send_request(options)
     end
 
-    # Creates a signing profile. A signing profile is a code signing
+    # Creates a signing profile. A signing profile is a code-signing
     # template that can be used to carry out a pre-defined signing job.
     #
     # @option params [required, String] :profile_name
@@ -1220,7 +1235,8 @@ module Aws::Signer
     #   Specifies the object digest (hash) to sign.
     #
     # @option params [required, String] :payload_format
-    #   Payload content type
+    #   Payload content type. The single valid type is
+    #   `application/vnd.cncf.notary.payload.v1+json`.
     #
     # @return [Types::SignPayloadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1264,14 +1280,14 @@ module Aws::Signer
     #
     # * Your S3 source bucket must be version enabled.
     #
-    # * You must create an S3 destination bucket. Code signing uses your S3
+    # * You must create an S3 destination bucket. AWS Signer uses your S3
     #   destination bucket to write your signed code.
     #
     # * You specify the name of the source and destination buckets when
     #   calling the `StartSigningJob` operation.
     #
     # * You must also specify a request token that identifies your request
-    #   to code signing.
+    #   to Signer.
     #
     # You can call the DescribeSigningJob and the ListSigningJobs actions
     # after you call `StartSigningJob`.
@@ -1417,7 +1433,7 @@ module Aws::Signer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-signer'
-      context[:gem_version] = '1.47.0'
+      context[:gem_version] = '1.48.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -32,7 +32,7 @@ module Aws::Signer
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://signer-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

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

@@ -211,8 +211,8 @@ module Aws::Signer
     #   @return [Types::SigningJobRevocationRecord]
     #
     # @!attribute [rw] signed_object
-    #   Name of the S3 bucket where the signed code image is saved by code
-    #   signing.
+    #   Name of the S3 bucket where the signed code image is saved by AWS
+    #   Signer.
     #   @return [Types::SignedObject]
     #
     # @!attribute [rw] job_owner
@@ -264,16 +264,16 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The encryption algorithm options that are available to a code signing
+    # The encryption algorithm options that are available to a code-signing
     # job.
     #
     # @!attribute [rw] allowed_values
-    #   The set of accepted encryption algorithms that are allowed in a code
-    #   signing job.
+    #   The set of accepted encryption algorithms that are allowed in a
+    #   code-signing job.
     #   @return [Array<String>]
     #
     # @!attribute [rw] default_value
-    #   The default encryption algorithm that is used by a code signing job.
+    #   The default encryption algorithm that is used by a code-signing job.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/EncryptionAlgorithmOptions AWS API Documentation
@@ -308,6 +308,22 @@ module Aws::Signer
     #   (signed by the parent CA) combined with a parent CA TBS hash (signed
     #   by the parent CA’s CA). Root certificates are defined as their own
     #   CA.
+    #
+    #   The following example shows how to calculate a hash for this
+    #   parameter using OpenSSL commands:
+    #
+    #   `openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs`
+    #
+    #   `openssl sha384 < childCert.tbs -binary > childCertTbsHash`
+    #
+    #   `openssl asn1parse -in parentCert.pem -strparse 4 -out
+    #   parentCert.tbs`
+    #
+    #   `openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p
+    #   childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >>
+    #   certificateHash.hex`
+    #
+    #   `cat certificateHash.hex | tr -d '\n'`
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetRevocationStatusRequest AWS API Documentation
@@ -323,9 +339,9 @@ module Aws::Signer
     end
 
     # @!attribute [rw] revoked_entities
-    #   A list of revoked entities (including one or more of the signing
-    #   profile ARN, signing job ID, and certificate hash) supplied as input
-    #   to the API.
+    #   A list of revoked entities (including zero or more of the signing
+    #   profile ARN, signing job ARN, and certificate hashes) supplied as
+    #   input to the API.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetRevocationStatusResponse AWS API Documentation
@@ -500,14 +516,14 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The hash algorithms that are available to a code signing job.
+    # The hash algorithms that are available to a code-signing job.
     #
     # @!attribute [rw] allowed_values
-    #   The set of accepted hash algorithms allowed in a code signing job.
+    #   The set of accepted hash algorithms allowed in a code-signing job.
     #   @return [Array<String>]
     #
     # @!attribute [rw] default_value
-    #   The default hash algorithm that is used in a code signing job.
+    #   The default hash algorithm that is used in a code-signing job.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/HashAlgorithmOptions AWS API Documentation
@@ -1016,16 +1032,16 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The name and prefix of the S3 bucket where code signing saves your
-    # signed objects.
+    # The name and prefix of the Amazon S3 bucket where AWS Signer saves
+    # your signed objects.
     #
     # @!attribute [rw] bucket_name
     #   Name of the S3 bucket.
     #   @return [String]
     #
     # @!attribute [rw] prefix
-    #   An Amazon S3 prefix that you can use to limit responses to those
-    #   that begin with the specified prefix.
+    #   An S3 prefix that you can use to limit responses to those that begin
+    #   with the specified prefix.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3Destination AWS API Documentation
@@ -1037,7 +1053,7 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The S3 bucket name and key where code signing saved your signed code
+    # The Amazon S3 bucket name and key where Signer saved your signed code
     # image.
     #
     # @!attribute [rw] bucket_name
@@ -1058,7 +1074,8 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # Information about the S3 bucket where you saved your unsigned code.
+    # Information about the Amazon S3 bucket where you saved your unsigned
+    # code.
     #
     # @!attribute [rw] bucket_name
     #   Name of the S3 bucket.
@@ -1112,7 +1129,8 @@ module Aws::Signer
     #   @return [String]
     #
     # @!attribute [rw] payload_format
-    #   Payload content type
+    #   Payload content type. The single valid type is
+    #   `application/vnd.cncf.notary.payload.v1+json`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SignPayloadRequest AWS API Documentation
@@ -1136,8 +1154,7 @@ module Aws::Signer
     #
     # @!attribute [rw] metadata
     #   Information including the signing profile ARN and the signing job
-    #   ID. Clients use metadata to signature records, for example, as
-    #   annotations added to the signature manifest inside an OCI registry.
+    #   ID.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] signature
@@ -1189,15 +1206,15 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The configuration of a code signing operation.
+    # The configuration of a signing operation.
     #
     # @!attribute [rw] encryption_algorithm_options
-    #   The encryption algorithm options that are available for a code
-    #   signing job.
+    #   The encryption algorithm options that are available for a
+    #   code-signing job.
     #   @return [Types::EncryptionAlgorithmOptions]
     #
     # @!attribute [rw] hash_algorithm_options
-    #   The hash algorithm options that are available for a code signing
+    #   The hash algorithm options that are available for a code-signing
     #   job.
     #   @return [Types::HashAlgorithmOptions]
     #
@@ -1215,12 +1232,12 @@ module Aws::Signer
     #
     # @!attribute [rw] encryption_algorithm
     #   A specified override of the default encryption algorithm that is
-    #   used in a code signing job.
+    #   used in a code-signing job.
     #   @return [String]
     #
     # @!attribute [rw] hash_algorithm
     #   A specified override of the default hash algorithm that is used in a
-    #   code signing job.
+    #   code-signing job.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningConfigurationOverrides AWS API Documentation
@@ -1232,14 +1249,14 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # The image format of a code signing platform or profile.
+    # The image format of a AWS Signer platform or profile.
     #
     # @!attribute [rw] supported_formats
-    #   The supported formats of a code signing image.
+    #   The supported formats of a signing image.
     #   @return [Array<String>]
     #
     # @!attribute [rw] default_format
-    #   The default format of a code signing image.
+    #   The default format of a signing image.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningImageFormat AWS API Documentation
@@ -1373,41 +1390,41 @@ module Aws::Signer
     end
 
     # Contains information about the signing configurations and parameters
-    # that are 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.
+    #   The ID of a signing platform.
     #   @return [String]
     #
     # @!attribute [rw] display_name
-    #   The display name of a code signing platform.
+    #   The display name of a signing platform.
     #   @return [String]
     #
     # @!attribute [rw] partner
-    #   Any partner entities linked to a code signing platform.
+    #   Any partner entities linked to a signing platform.
     #   @return [String]
     #
     # @!attribute [rw] target
-    #   The types of targets that can be signed by a code signing platform.
+    #   The types of targets that can be signed by a signing platform.
     #   @return [String]
     #
     # @!attribute [rw] category
-    #   The category of a code signing platform.
+    #   The category of a signing platform.
     #   @return [String]
     #
     # @!attribute [rw] signing_configuration
-    #   The configuration of a code signing platform. This includes the
+    #   The configuration of a signing platform. This includes the
     #   designated hash algorithm and encryption algorithm of a signing
     #   platform.
     #   @return [Types::SigningConfiguration]
     #
     # @!attribute [rw] signing_image_format
-    #   The image format of a code signing platform or profile.
+    #   The image format of a AWS Signer platform or profile.
     #   @return [Types::SigningImageFormat]
     #
     # @!attribute [rw] max_size_in_mb
-    #   The maximum size (in MB) of code that can be signed by a code
-    #   signing platform.
+    #   The maximum size (in MB) of code that can be signed by a signing
+    #   platform.
     #   @return [Integer]
     #
     # @!attribute [rw] revocation_supported
@@ -1430,7 +1447,7 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # Any overrides that are applied to the signing configuration of a code
+    # Any overrides that are applied to the signing configuration of a
     # signing platform.
     #
     # @!attribute [rw] signing_configuration
@@ -1456,7 +1473,7 @@ module Aws::Signer
       include Aws::Structure
     end
 
-    # Contains information about the ACM certificates and code signing
+    # Contains information about the ACM certificates and signing
     # configuration parameters that can be used by a given code signing
     # user.
     #
@@ -1490,11 +1507,11 @@ module Aws::Signer
     #   @return [String]
     #
     # @!attribute [rw] signing_parameters
-    #   The parameters that are available for use by a code signing user.
+    #   The parameters that are available for use by a Signer user.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] status
-    #   The status of a code signing profile.
+    #   The status of a signing profile.
     #   @return [String]
     #
     # @!attribute [rw] arn

data/lib/aws-sdk-signer.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-signer/customizations'
 # @!group service
 module Aws::Signer
 
-  GEM_VERSION = '1.47.0'
+  GEM_VERSION = '1.48.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-signer
 version: !ruby/object:Gem::Version
-  version: 1.47.0
+  version: 1.48.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core