docs(client-signer): Documentation updates for AWS Signer

Author: awstools

clients/client-signer/README.md

@@ -6,20 +6,23 @@
 
 AWS SDK for JavaScript Signer Client for Node.js, Browser and React Native.
 
-<p>AWS Signer is a fully managed code signing service to help you ensure the trust and
+<p>AWS Signer is a fully managed code-signing service to help you ensure the trust and
 integrity of your code. </p>
-<p>AWS Signer supports the following applications:</p>
+<p>Signer supports the following applications:</p>
 <p>With code signing for AWS Lambda, you can sign <a href="http://docs.aws.amazon.com/lambda/latest/dg/">AWS
 Lambda</a> deployment packages. Integrated support is provided for <a href="http://docs.aws.amazon.com/AmazonS3/latest/gsg/">Amazon S3</a>, <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/">Amazon
 CloudWatch</a>, and <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail</a>. In order
-to sign code, you create a signing profile and then use Signer to sign Lambda zip files
-in S3. </p>
+to sign code, you create a signing profile and then use Signer to sign Lambda zip
+files in S3. </p>
 <p>With code signing for IoT, you can sign code for any IoT device that is supported by AWS.
-IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code signing
+IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code-signing
 certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management. </p>
-<p>With code signing for
-containers …(TBD)</p>
-<p>For more information about AWS Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
+<p>With Signer and the Notation CLI from the <a href="https://notaryproject.dev/">Notary

+Project</a>, you can sign container images stored in a container registry such
+as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry
+alongside the images, where they are available for verifying image authenticity and
+integrity.</p>
+<p>For more information about Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
 Guide</a>.</p>
 
 ## Installing

clients/client-signer/src/Signer.ts

@@ -413,20 +413,23 @@ export interface Signer {
 
 /**
  * @public
- * <p>AWS Signer is a fully managed code signing service to help you ensure the trust and
+ * <p>AWS Signer is a fully managed code-signing service to help you ensure the trust and
  * 			integrity of your code. </p>
- * 		       <p>AWS Signer supports the following applications:</p>
+ * 		       <p>Signer supports the following applications:</p>
  * 		       <p>With code signing for AWS Lambda, you can sign <a href="http://docs.aws.amazon.com/lambda/latest/dg/">AWS
  * 				Lambda</a> deployment packages. Integrated support is provided for <a href="http://docs.aws.amazon.com/AmazonS3/latest/gsg/">Amazon S3</a>, <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/">Amazon
  * 				CloudWatch</a>, and <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail</a>. In order
- * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip files
- * 			in S3. </p>
+ * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip
+ * 			files in S3. </p>
  * 		       <p>With code signing for IoT, you can sign code for any IoT device that is supported by AWS.
- * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code signing
+ * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code-signing
  * 			certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management. </p>
- * 		       <p>With code signing for
- * 			containers …(TBD)</p>
- * 		       <p>For more information about AWS Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
+ * 		       <p>With Signer and the Notation CLI from the <a href="https://notaryproject.dev/">Notary
+ * 				Project</a>, you can sign container images stored in a container registry such
+ * 			as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry
+ * 			alongside the images, where they are available for verifying image authenticity and
+ * 			integrity.</p>
+ * 		       <p>For more information about Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
  * 			Guide</a>.</p>
  */
 export class Signer extends SignerClient implements Signer {}

clients/client-signer/src/SignerClient.ts

@@ -327,20 +327,23 @@ export interface SignerClientResolvedConfig extends SignerClientResolvedConfigTy
 
 /**
  * @public
- * <p>AWS Signer is a fully managed code signing service to help you ensure the trust and
+ * <p>AWS Signer is a fully managed code-signing service to help you ensure the trust and
  * 			integrity of your code. </p>
- * 		       <p>AWS Signer supports the following applications:</p>
+ * 		       <p>Signer supports the following applications:</p>
  * 		       <p>With code signing for AWS Lambda, you can sign <a href="http://docs.aws.amazon.com/lambda/latest/dg/">AWS
  * 				Lambda</a> deployment packages. Integrated support is provided for <a href="http://docs.aws.amazon.com/AmazonS3/latest/gsg/">Amazon S3</a>, <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/">Amazon
  * 				CloudWatch</a>, and <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail</a>. In order
- * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip files
- * 			in S3. </p>
+ * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip
+ * 			files in S3. </p>
  * 		       <p>With code signing for IoT, you can sign code for any IoT device that is supported by AWS.
- * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code signing
+ * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code-signing
  * 			certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management. </p>
- * 		       <p>With code signing for
- * 			containers …(TBD)</p>
- * 		       <p>For more information about AWS Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
+ * 		       <p>With Signer and the Notation CLI from the <a href="https://notaryproject.dev/">Notary
+ * 				Project</a>, you can sign container images stored in a container registry such
+ * 			as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry
+ * 			alongside the images, where they are available for verifying image authenticity and
+ * 			integrity.</p>
+ * 		       <p>For more information about Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
  * 			Guide</a>.</p>
  */
 export class SignerClient extends __Client<

clients/client-signer/src/commands/GetRevocationStatusCommand.ts

@@ -37,9 +37,8 @@ export interface GetRevocationStatusCommandOutput extends GetRevocationStatusRes
 
 /**
  * @public
- * <p>Retrieves the
- * 			revocation status of one or more of the signing profile, signing job, and signing
- * 			certificate.</p>
+ * <p>Retrieves the revocation status of one or more of the signing profile, signing job,
+ * 			and signing certificate.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-signer/src/commands/ListSigningJobsCommand.ts

@@ -37,12 +37,12 @@ export interface ListSigningJobsCommandOutput extends ListSigningJobsResponse, _
 
 /**
  * @public
- * <p>Lists all your signing jobs. You can use the <code>maxResults</code> 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 <code>nextToken</code> value. Use this value in
+ * <p>Lists all your signing jobs. You can use the <code>maxResults</code> parameter to limit the
+ * 			number of signing jobs that are returned in the response. If additional jobs remain to
+ * 			be listed, AWS Signer returns a <code>nextToken</code> value. Use this value in
  * 			subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can
  * 			continue calling <code>ListSigningJobs</code> with your <code>maxResults</code>
- * 			parameter and with new values that code signing returns in the <code>nextToken</code>
+ * 			parameter and with new values that Signer returns in the <code>nextToken</code>
  * 			parameter until all of your signing jobs have been returned. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

clients/client-signer/src/commands/ListSigningPlatformsCommand.ts

@@ -37,11 +37,11 @@ export interface ListSigningPlatformsCommandOutput extends ListSigningPlatformsR
 
 /**
  * @public
- * <p>Lists all signing platforms available in code signing that match the request parameters. If
- * 			additional jobs remain to be listed, code signing returns a <code>nextToken</code> value. Use
- * 			this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining
- * 			values. You can continue calling <code>ListSigningJobs</code> with your
- * 				<code>maxResults</code> parameter and with new values that code signing returns in the
+ * <p>Lists all signing platforms available in AWS Signer that match the request parameters. If
+ * 			additional jobs remain to be listed, Signer returns a <code>nextToken</code> value.
+ * 			Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the
+ * 			remaining values. You can continue calling <code>ListSigningJobs</code> with your
+ * 				<code>maxResults</code> parameter and with new values that Signer returns in the
  * 				<code>nextToken</code> parameter until all of your signing jobs have been
  * 			returned.</p>
  * @example

clients/client-signer/src/commands/ListSigningProfilesCommand.ts

@@ -37,14 +37,14 @@ export interface ListSigningProfilesCommandOutput extends ListSigningProfilesRes
 
 /**
  * @public
- * <p>Lists all available signing profiles in your AWS account. Returns only profiles with
- * 			an <code>ACTIVE</code> status unless the <code>includeCanceled</code> request field is
- * 			set to <code>true</code>. If additional jobs remain to be listed, code signing returns a
+ * <p>Lists all available signing profiles in your AWS account. Returns only profiles with an
+ * 				<code>ACTIVE</code> status unless the <code>includeCanceled</code> request field is
+ * 			set to <code>true</code>. If additional jobs remain to be listed, AWS Signer returns a
  * 				<code>nextToken</code> value. Use this value in subsequent calls to
  * 				<code>ListSigningJobs</code> to fetch the remaining values. You can continue calling
  * 				<code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with
- * 			new values that code signing returns in the <code>nextToken</code> parameter until all of your
- * 			signing jobs have been returned.</p>
+ * 			new values that Signer returns in the <code>nextToken</code> parameter until all of
+ * 			your signing jobs have been returned.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-signer/src/commands/PutSigningProfileCommand.ts

@@ -37,7 +37,7 @@ export interface PutSigningProfileCommandOutput extends PutSigningProfileRespons
 
 /**
  * @public
- * <p>Creates a signing profile. A signing profile is a code signing template that can be used to
+ * <p>Creates a signing profile. A signing profile is a code-signing template that can be used to
  * 			carry out a pre-defined signing job.
  * 			</p>
  * @example

clients/client-signer/src/commands/SignPayloadCommand.ts

@@ -37,8 +37,7 @@ export interface SignPayloadCommandOutput extends SignPayloadResponse, __Metadat
 
 /**
  * @public
- * <p>Signs a binary
- * 			payload and returns a signature envelope.</p>
+ * <p>Signs a binary payload and returns a signature envelope.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-signer/src/commands/StartSigningJobCommand.ts

@@ -49,16 +49,15 @@ export interface StartSigningJobCommandOutput extends StartSigningJobResponse, _
  * 				           <p>Your S3 source bucket must be version enabled.</p>
  * 			         </li>
  *             <li>
- * 				           <p>You must create an S3 destination bucket. Code signing uses your S3 destination
- * 					bucket to write your signed code.</p>
+ * 				           <p>You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to
+ * 					write your signed code.</p>
  * 			         </li>
  *             <li>
  * 				           <p>You specify the name of the source and destination buckets when calling the
  * 						<code>StartSigningJob</code> operation.</p>
  * 			         </li>
  *             <li>
- * 				           <p>You must also specify a request token that identifies your request to
- * 					code signing.</p>
+ * 				           <p>You must also specify a request token that identifies your request to Signer.</p>
  * 			         </li>
  *          </ul>
  * 		       <p>You can call the <a>DescribeSigningJob</a> and the <a>ListSigningJobs</a> actions after you call

clients/client-signer/src/index.ts

@@ -1,20 +1,23 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>AWS Signer is a fully managed code signing service to help you ensure the trust and
+ * <p>AWS Signer is a fully managed code-signing service to help you ensure the trust and
  * 			integrity of your code. </p>
- * 		       <p>AWS Signer supports the following applications:</p>
+ * 		       <p>Signer supports the following applications:</p>
  * 		       <p>With code signing for AWS Lambda, you can sign <a href="http://docs.aws.amazon.com/lambda/latest/dg/">AWS
  * 				Lambda</a> deployment packages. Integrated support is provided for <a href="http://docs.aws.amazon.com/AmazonS3/latest/gsg/">Amazon S3</a>, <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/">Amazon
  * 				CloudWatch</a>, and <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail</a>. In order
- * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip files
- * 			in S3. </p>
+ * 			to sign code, you create a signing profile and then use Signer to sign Lambda zip
+ * 			files in S3. </p>
  * 		       <p>With code signing for IoT, you can sign code for any IoT device that is supported by AWS.
- * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code signing
+ * 			IoT code signing is available for <a href="http://docs.aws.amazon.com/freertos/latest/userguide/">Amazon FreeRTOS</a> and <a href="http://docs.aws.amazon.com/iot/latest/developerguide/">AWS IoT Device Management</a>, and is integrated with <a href="http://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager (ACM)</a>. In order to sign code, you import a third-party code-signing
  * 			certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management. </p>
- * 		       <p>With code signing for
- * 			containers …(TBD)</p>
- * 		       <p>For more information about AWS Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
+ * 		       <p>With Signer and the Notation CLI from the <a href="https://notaryproject.dev/">Notary
+ * 				Project</a>, you can sign container images stored in a container registry such
+ * 			as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry
+ * 			alongside the images, where they are available for verifying image authenticity and
+ * 			integrity.</p>
+ * 		       <p>For more information about Signer, see the <a href="https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html">AWS Signer Developer
  * 			Guide</a>.</p>
  *
  * @packageDocumentation