@aws-sdk/client-securityagent 3.1040.0 → 3.1042.0

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

@@ -27,7 +27,7 @@ declare const InitiateProviderRegistrationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Initiates the registration of Security Agent App for an external Provider
+ * <p>Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,24 +55,22 @@ declare const InitiateProviderRegistrationCommand_base: {
  * @see {@link SecurityAgentClientResolvedConfig | config} for SecurityAgentClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  Request denied due to insufficient permissions
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Request conflicts with current resource state
+ *  <p>The request could not be completed due to a conflict with the current state of the resource.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected server error occurred
+ *  <p>An unexpected error occurred during the processing of your request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Specified resource was not found
+ *  <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request denied due to throttling
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  A standard error for input validation failures.
- * This should be thrown by services when a member of the input structure
- * falls outside of the modeled or documented constraints.
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
  *
  * @throws {@link SecurityAgentServiceException}
  * <p>Base exception class for all service exceptions from SecurityAgent service.</p>

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

@@ -27,7 +27,7 @@ declare const ListAgentSpacesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists agent spaces
+ * <p>Returns a paginated list of agent space summaries in your account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListApplicationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists all applications in the account
+ * <p>Returns a paginated list of application summaries in your account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListArtifactsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists the artifacts for the associated agent space
+ * <p>Returns a paginated list of artifact summaries for the specified agent space.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -63,21 +63,19 @@ declare const ListArtifactsCommand_base: {
  * @see {@link SecurityAgentClientResolvedConfig | config} for SecurityAgentClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  Request denied due to insufficient permissions
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected server error occurred
+ *  <p>An unexpected error occurred during the processing of your request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Specified resource was not found
+ *  <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request denied due to throttling
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  A standard error for input validation failures.
- * This should be thrown by services when a member of the input structure
- * falls outside of the modeled or documented constraints.
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
  *
  * @throws {@link SecurityAgentServiceException}
  * <p>Base exception class for all service exceptions from SecurityAgent service.</p>

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

@@ -27,7 +27,7 @@ declare const ListDiscoveredEndpointsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists discovered endpoints associated with a pentest job with optional URI prefix filtering
+ * <p>Returns a paginated list of endpoints discovered during a pentest job execution.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListFindingsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists findings with filtering and pagination support. When filters are applied, the actual number of results returned may be less than the specified limit
+ * <p>Lists the security findings for a pentest job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListIntegratedResourcesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists the integrated resources for an agent space
+ * <p>Lists the integrated resources for an agent space, optionally filtered by integration or resource type.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -77,21 +77,19 @@ declare const ListIntegratedResourcesCommand_base: {
  * @see {@link SecurityAgentClientResolvedConfig | config} for SecurityAgentClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  Request denied due to insufficient permissions
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected server error occurred
+ *  <p>An unexpected error occurred during the processing of your request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Specified resource was not found
+ *  <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request denied due to throttling
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  A standard error for input validation failures.
- * This should be thrown by services when a member of the input structure
- * falls outside of the modeled or documented constraints.
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
  *
  * @throws {@link SecurityAgentServiceException}
  * <p>Base exception class for all service exceptions from SecurityAgent service.</p>

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

@@ -27,7 +27,7 @@ declare const ListIntegrationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Retrieves the Integrations associated with the user's account
+ * <p>Lists the integrations in your account, optionally filtered by provider or provider type.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -68,16 +68,19 @@ declare const ListIntegrationsCommand_base: {
  * @see {@link SecurityAgentClientResolvedConfig | config} for SecurityAgentClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  Request denied due to insufficient permissions
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected server error occurred
+ *  <p>An unexpected error occurred during the processing of your request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Specified resource was not found
+ *  <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request denied due to throttling
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
  *
  * @throws {@link SecurityAgentServiceException}
  * <p>Base exception class for all service exceptions from SecurityAgent service.</p>

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

@@ -27,7 +27,7 @@ declare const ListMembershipsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists all members associated to an agent space with pagination support
+ * <p>Returns a paginated list of membership summaries for the specified agent space within an application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListPentestJobTasksCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists tasks associated with a specific pentest job
+ * <p>Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListPentestJobsForPentestCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists pentest jobs associated with a pentest
+ * <p>Returns a paginated list of pentest job summaries for the specified pentest configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListPentestsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists pentests with optional filtering by status
+ * <p>Returns a paginated list of pentest summaries for the specified agent space.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListTagsForResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists tags for a Security Agent resource
+ * <p>Returns the tags associated with the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const ListTargetDomainsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Lists target domains
+ * <p>Returns a paginated list of target domain summaries in your account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const StartCodeRemediationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Starts code remediation for the specified findings
+ * <p>Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const StartPentestJobCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Initiates the execution of a pentest
+ * <p>Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const StopPentestJobCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Stops the execution of a running pentest
+ * <p>Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Adds tags to a Security Agent resource
+ * <p>Adds tags to a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Removes tags from a Security Agent resource
+ * <p>Removes tags from a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UpdateAgentSpaceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates an agent space record
+ * <p>Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UpdateApplicationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates application configuration
+ * <p>Updates the configuration of an existing application, including the IAM role and default KMS key.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UpdateFindingCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates an existing security finding with new details or status
+ * <p>Updates the status or risk level of a security finding.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UpdateIntegratedResourcesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates the integrated resources for an agent space
+ * <p>Updates the integrated resources for an agent space, including their capabilities.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,24 +69,22 @@ declare const UpdateIntegratedResourcesCommand_base: {
  * @see {@link SecurityAgentClientResolvedConfig | config} for SecurityAgentClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  Request denied due to insufficient permissions
+ *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  Request conflicts with current resource state
+ *  <p>The request could not be completed due to a conflict with the current state of the resource.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  Unexpected server error occurred
+ *  <p>An unexpected error occurred during the processing of your request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  Specified resource was not found
+ *  <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  Request denied due to throttling
+ *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  A standard error for input validation failures.
- * This should be thrown by services when a member of the input structure
- * falls outside of the modeled or documented constraints.
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
  *
  * @throws {@link SecurityAgentServiceException}
  * <p>Base exception class for all service exceptions from SecurityAgent service.</p>

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

@@ -27,7 +27,7 @@ declare const UpdatePentestCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates an existing pentest with new configuration or settings
+ * <p>Updates an existing pentest configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const UpdateTargetDomainCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Updates a target domain record
+ * <p>Updates the verification method for a target domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -38,7 +38,7 @@ declare const UpdateTargetDomainCommand_base: {
  * const client = new SecurityAgentClient(config);
  * const input = { // UpdateTargetDomainInput
  *   targetDomainId: "STRING_VALUE", // required
- *   verificationMethod: "DNS_TXT" || "HTTP_ROUTE", // required
+ *   verificationMethod: "DNS_TXT" || "HTTP_ROUTE" || "PRIVATE_VPC", // required
  * };
  * const command = new UpdateTargetDomainCommand(input);
  * const response = await client.send(command);
@@ -46,8 +46,9 @@ declare const UpdateTargetDomainCommand_base: {
  * //   targetDomainId: "STRING_VALUE", // required
  * //   domainName: "STRING_VALUE", // required
  * //   verificationStatus: "PENDING" || "VERIFIED" || "FAILED" || "UNREACHABLE", // required
+ * //   verificationStatusReason: "STRING_VALUE",
  * //   verificationDetails: { // VerificationDetails
- * //     method: "DNS_TXT" || "HTTP_ROUTE",
+ * //     method: "DNS_TXT" || "HTTP_ROUTE" || "PRIVATE_VPC",
  * //     dnsTxt: { // DnsVerification
  * //       token: "STRING_VALUE",
  * //       dnsRecordName: "STRING_VALUE",

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

@@ -27,7 +27,7 @@ declare const VerifyTargetDomainCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Verifies ownership for a registered target domain
+ * <p>Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -48,6 +48,7 @@ declare const VerifyTargetDomainCommand_base: {
  * //   updatedAt: new Date("TIMESTAMP"),
  * //   verifiedAt: new Date("TIMESTAMP"),
  * //   status: "PENDING" || "VERIFIED" || "FAILED" || "UNREACHABLE",
+ * //   verificationStatusReason: "STRING_VALUE",
  * // };
  *
  * ```

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p>AWS Security Agent service documentation.</p>
+ * <p>AWS Security Agent is a frontier agent that proactively secures your applications throughout the development lifecycle. It conducts automated security reviews tailored to your organizational requirements and delivers context-aware penetration testing on demand. By continuously validating security from design to deployment, AWS Security Agent helps prevent vulnerabilities early across all your environments. Key capabilities include design security review for architecture documents, code security review for pull requests in connected repositories, and on-demand penetration testing that discovers, validates, and remediates security vulnerabilities through tailored multi-step attack scenarios. For more information, see the <a href="https://docs.aws.amazon.com/securityagent/latest/userguide/what-is.html">AWS Security Agent User Guide</a>.</p>
  *
  * @packageDocumentation
  */