@aws-sdk/client-signer 3.296.0 → 3.297.0

package/dist-types/commands/ListSigningProfilesCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListSigningProfilesRequest, ListSigningProfilesResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link ListSigningProfilesCommand}.
  */
 export interface ListSigningProfilesCommandInput extends ListSigningProfilesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListSigningProfilesCommand}.
  */
 export interface ListSigningProfilesCommandOutput extends ListSigningProfilesResponse, __MetadataBearer {
 }
 /**
+ * @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
@@ -32,6 +37,8 @@ export interface ListSigningProfilesCommandOutput extends ListSigningProfilesRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListSigningProfilesCommandInput - {@link ListSigningProfilesCommandInput}
+ * @returns {@link ListSigningProfilesCommandOutput}
  * @see {@link ListSigningProfilesCommandInput} for command's `input` shape.
  * @see {@link ListSigningProfilesCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListSigningProfilesCommandOutput extends ListSigningProfilesRes
 export declare class ListSigningProfilesCommand extends $Command<ListSigningProfilesCommandInput, ListSigningProfilesCommandOutput, SignerClientResolvedConfig> {
     readonly input: ListSigningProfilesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListSigningProfilesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSigningProfilesCommandInput, ListSigningProfilesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of the tags associated with a signing profile resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SignerClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/PutSigningProfileCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutSigningProfileRequest, PutSigningProfileResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link PutSigningProfileCommand}.
  */
 export interface PutSigningProfileCommandInput extends PutSigningProfileRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutSigningProfileCommand}.
  */
 export interface PutSigningProfileCommandOutput extends PutSigningProfileResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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. For more information, see <a href="http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html">http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html</a>
  *          </p>
@@ -27,6 +32,8 @@ export interface PutSigningProfileCommandOutput extends PutSigningProfileRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param PutSigningProfileCommandInput - {@link PutSigningProfileCommandInput}
+ * @returns {@link PutSigningProfileCommandOutput}
  * @see {@link PutSigningProfileCommandInput} for command's `input` shape.
  * @see {@link PutSigningProfileCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface PutSigningProfileCommandOutput extends PutSigningProfileRespons
 export declare class PutSigningProfileCommand extends $Command<PutSigningProfileCommandInput, PutSigningProfileCommandOutput, SignerClientResolvedConfig> {
     readonly input: PutSigningProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutSigningProfileCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSigningProfileCommandInput, PutSigningProfileCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RemoveProfilePermissionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RemoveProfilePermissionRequest, RemoveProfilePermissionResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link RemoveProfilePermissionCommand}.
  */
 export interface RemoveProfilePermissionCommandInput extends RemoveProfilePermissionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RemoveProfilePermissionCommand}.
  */
 export interface RemoveProfilePermissionCommandOutput extends RemoveProfilePermissionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes cross-account permissions from a signing profile.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RemoveProfilePermissionCommandOutput extends RemoveProfilePermi
  * const response = await client.send(command);
  * ```
  *
+ * @param RemoveProfilePermissionCommandInput - {@link RemoveProfilePermissionCommandInput}
+ * @returns {@link RemoveProfilePermissionCommandOutput}
  * @see {@link RemoveProfilePermissionCommandInput} for command's `input` shape.
  * @see {@link RemoveProfilePermissionCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -53,11 +60,20 @@ export interface RemoveProfilePermissionCommandOutput extends RemoveProfilePermi
 export declare class RemoveProfilePermissionCommand extends $Command<RemoveProfilePermissionCommandInput, RemoveProfilePermissionCommandOutput, SignerClientResolvedConfig> {
     readonly input: RemoveProfilePermissionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RemoveProfilePermissionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveProfilePermissionCommandInput, RemoveProfilePermissionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RevokeSignatureCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RevokeSignatureRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link RevokeSignatureCommand}.
  */
 export interface RevokeSignatureCommandInput extends RevokeSignatureRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RevokeSignatureCommand}.
  */
 export interface RevokeSignatureCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Changes the state of a signing job to REVOKED. This indicates that the signature is no
  * 			longer valid.</p>
  * @example
@@ -26,6 +31,8 @@ export interface RevokeSignatureCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param RevokeSignatureCommandInput - {@link RevokeSignatureCommandInput}
+ * @returns {@link RevokeSignatureCommandOutput}
  * @see {@link RevokeSignatureCommandInput} for command's `input` shape.
  * @see {@link RevokeSignatureCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -51,11 +58,20 @@ export interface RevokeSignatureCommandOutput extends __MetadataBearer {
 export declare class RevokeSignatureCommand extends $Command<RevokeSignatureCommandInput, RevokeSignatureCommandOutput, SignerClientResolvedConfig> {
     readonly input: RevokeSignatureCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RevokeSignatureCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RevokeSignatureCommandInput, RevokeSignatureCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RevokeSigningProfileCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RevokeSigningProfileRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link RevokeSigningProfileCommand}.
  */
 export interface RevokeSigningProfileCommandInput extends RevokeSigningProfileRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RevokeSigningProfileCommand}.
  */
 export interface RevokeSigningProfileCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Changes the state of a signing profile to REVOKED. This indicates that signatures
  * 			generated using the signing profile after an effective start date are no longer
  * 			valid.</p>
@@ -27,6 +32,8 @@ export interface RevokeSigningProfileCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param RevokeSigningProfileCommandInput - {@link RevokeSigningProfileCommandInput}
+ * @returns {@link RevokeSigningProfileCommandOutput}
  * @see {@link RevokeSigningProfileCommandInput} for command's `input` shape.
  * @see {@link RevokeSigningProfileCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface RevokeSigningProfileCommandOutput extends __MetadataBearer {
 export declare class RevokeSigningProfileCommand extends $Command<RevokeSigningProfileCommandInput, RevokeSigningProfileCommandOutput, SignerClientResolvedConfig> {
     readonly input: RevokeSigningProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RevokeSigningProfileCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RevokeSigningProfileCommandInput, RevokeSigningProfileCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StartSigningJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartSigningJobRequest, StartSigningJobResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link StartSigningJobCommand}.
  */
 export interface StartSigningJobCommandInput extends StartSigningJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartSigningJobCommand}.
  */
 export interface StartSigningJobCommandOutput extends StartSigningJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Initiates a signing job to be performed on the code provided. Signing jobs are
  * 			viewable by the <code>ListSigningJobs</code> operation for two years after they are
  * 			performed. Note the following requirements: </p>
@@ -52,6 +57,8 @@ export interface StartSigningJobCommandOutput extends StartSigningJobResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param StartSigningJobCommandInput - {@link StartSigningJobCommandInput}
+ * @returns {@link StartSigningJobCommandOutput}
  * @see {@link StartSigningJobCommandInput} for command's `input` shape.
  * @see {@link StartSigningJobCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -81,11 +88,20 @@ export interface StartSigningJobCommandOutput extends StartSigningJobResponse, _
 export declare class StartSigningJobCommand extends $Command<StartSigningJobCommandInput, StartSigningJobCommandOutput, SignerClientResolvedConfig> {
     readonly input: StartSigningJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartSigningJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSigningJobCommandInput, StartSigningJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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. To specify the signing profile, use its Amazon Resource Name (ARN). To specify
@@ -28,6 +33,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -51,11 +58,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SignerClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SignerClientResolvedConfig } from "../SignerClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from a signing profile. To remove the tags, specify a list of
  * 			tag keys.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link SignerClientResolvedConfig | config} for SignerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SignerClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SignerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SignerServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Signer service.
  */
 export declare class SignerServiceException extends __ServiceException {