SecurityAgentClient

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 AWS Security Agent User Guide.

Properties

Link copied to clipboard
abstract override val config: SecurityAgentClient.Config

SecurityAgentClient's configuration

Functions

Link copied to clipboard
abstract suspend fun addArtifact(input: AddArtifactRequest): AddArtifactResponse

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

Link copied to clipboard

Batch creates security requirements in a customer managed pack.

Link copied to clipboard

Deletes one or more code reviews from an agent space.

Link copied to clipboard

Deletes one or more pentests from an agent space.

Link copied to clipboard

Batch deletes security requirements from a customer managed pack.

Link copied to clipboard

Deletes one or more threat models from an agent space.

Link copied to clipboard

Retrieves information about one or more agent spaces.

Link copied to clipboard

Retrieves metadata for one or more artifacts in an agent space.

Link copied to clipboard

Retrieves information about one or more code review jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a code review job.

Link copied to clipboard

Retrieves information about one or more code reviews in an agent space.

Link copied to clipboard

Retrieves information about one or more security findings in an agent space.

Link copied to clipboard

Retrieves information about one or more pentest jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a pentest job.

Link copied to clipboard

Retrieves information about one or more pentests in an agent space.

Link copied to clipboard

Batch retrieves security requirements from a pack.

Link copied to clipboard

Retrieves information about one or more target domains.

Link copied to clipboard

Retrieves information about one or more threat model jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a threat model job.

Link copied to clipboard

Retrieves information about one or more threat models in an agent space.

Link copied to clipboard

Retrieves information about one or more threats.

Link copied to clipboard

Batch updates security requirements within a customer managed pack.

Link copied to clipboard

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

Link copied to clipboard
abstract suspend fun createApplication(input: CreateApplicationRequest = CreateApplicationRequest { }): CreateApplicationResponse

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

Link copied to clipboard

Creates a new code review configuration in an agent space. A code review defines the parameters for automated security-focused code analysis.

Link copied to clipboard

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

Link copied to clipboard

Creates a new membership, granting a user access to an agent space within an application.

Link copied to clipboard

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

Link copied to clipboard

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

Link copied to clipboard

Creates a customer managed security requirement pack.

Link copied to clipboard

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

Link copied to clipboard

Creates a new threat under a threat model job.

Link copied to clipboard

Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis.

Link copied to clipboard

Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts.

Link copied to clipboard

Deletes an application and its associated configuration, including IAM Identity Center settings.

Link copied to clipboard

Deletes an artifact from an agent space.

Link copied to clipboard

Deletes an integration with a third-party provider.

Link copied to clipboard

Deletes a membership, revoking a user's access to an agent space.

Link copied to clipboard

Deletes a private connection.

Link copied to clipboard

Deletes a customer managed security requirement pack and all its associated security requirements.

Link copied to clipboard

Deletes a target domain registration. After deletion, the domain can no longer be used for penetration testing.

Link copied to clipboard

Retrieves the details of a private connection.

Link copied to clipboard

Retrieves information about an application.

Link copied to clipboard
abstract suspend fun getArtifact(input: GetArtifactRequest): GetArtifactResponse

Retrieves an artifact from an agent space.

Link copied to clipboard

Retrieves information about an integration.

Link copied to clipboard

Retrieves information about a security requirement pack.

Link copied to clipboard

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

Link copied to clipboard

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

Link copied to clipboard
abstract suspend fun listAgentSpaces(input: ListAgentSpacesRequest = ListAgentSpacesRequest { }): ListAgentSpacesResponse

Returns a paginated list of agent space summaries in your account.

Link copied to clipboard
abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

Returns a paginated list of application summaries in your account.

Link copied to clipboard

Returns a paginated list of artifact summaries for the specified agent space.

Link copied to clipboard

Returns a paginated list of code review job summaries for the specified code review configuration.

Link copied to clipboard

Returns a paginated list of task summaries for the specified code review job, optionally filtered by step name or category.

Link copied to clipboard

Returns a paginated list of code review summaries for the specified agent space.

Link copied to clipboard

Returns a paginated list of endpoints discovered during a pentest job execution.

Link copied to clipboard

Lists the security findings for a pentest job.

Link copied to clipboard

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

Link copied to clipboard
abstract suspend fun listIntegrations(input: ListIntegrationsRequest = ListIntegrationsRequest { }): ListIntegrationsResponse

Lists the integrations in your account, optionally filtered by provider or provider type.

Link copied to clipboard

Returns a paginated list of membership summaries for the specified agent space within an application.

Link copied to clipboard

Returns a paginated list of pentest job summaries for the specified pentest configuration.

Link copied to clipboard

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Link copied to clipboard

Returns a paginated list of pentest summaries for the specified agent space.

Link copied to clipboard
abstract suspend fun listPrivateConnections(input: ListPrivateConnectionsRequest = ListPrivateConnectionsRequest { }): ListPrivateConnectionsResponse

Lists the private connections in your account.

Link copied to clipboard
abstract suspend fun listSecurityRequirementPacks(input: ListSecurityRequirementPacksRequest = ListSecurityRequirementPacksRequest { }): ListSecurityRequirementPacksResponse

Lists all security requirement packs in the caller's account.

Link copied to clipboard

Lists security requirements within a pack.

Link copied to clipboard

Returns the tags associated with the specified resource.

Link copied to clipboard
abstract suspend fun listTargetDomains(input: ListTargetDomainsRequest = ListTargetDomainsRequest { }): ListTargetDomainsResponse

Returns a paginated list of target domain summaries in your account.

Link copied to clipboard

Returns a paginated list of threat model job summaries for the specified threat model.

Link copied to clipboard

Returns a paginated list of task summaries for the specified threat model job.

Link copied to clipboard

Returns a paginated list of threat model summaries for the specified agent space.

Link copied to clipboard
abstract suspend fun listThreats(input: ListThreatsRequest): ListThreatsResponse

Returns a paginated list of threats for a threat model job.

Link copied to clipboard

Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.

Link copied to clipboard

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

Link copied to clipboard

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

Link copied to clipboard

Starts a new threat model job for a threat model configuration.

Link copied to clipboard

Stops a running code review job. The job transitions to a stopping state and then to stopped after cleanup completes.

Link copied to clipboard

Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.

Link copied to clipboard

Stops a running threat model job.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.

Link copied to clipboard

Updates the configuration of an existing application, including the IAM role and default KMS key.

Link copied to clipboard

Updates an existing code review configuration.

Link copied to clipboard

Updates the status or risk level of a security finding.

Link copied to clipboard

Updates the integrated resources for an agent space, including their capabilities.

Link copied to clipboard

Updates an existing pentest configuration.

Link copied to clipboard

Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.

Link copied to clipboard

Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.

Link copied to clipboard

Updates the verification method for a target domain.

Link copied to clipboard

Updates a threat.

Link copied to clipboard

Updates an existing threat model configuration.

Link copied to clipboard

Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.

Inherited functions

Link copied to clipboard

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

Link copied to clipboard

Batch creates security requirements in a customer managed pack.

Link copied to clipboard

Deletes one or more code reviews from an agent space.

Link copied to clipboard

Deletes one or more pentests from an agent space.

Link copied to clipboard

Batch deletes security requirements from a customer managed pack.

Link copied to clipboard

Deletes one or more threat models from an agent space.

Link copied to clipboard

Retrieves information about one or more agent spaces.

Link copied to clipboard

Retrieves metadata for one or more artifacts in an agent space.

Link copied to clipboard

Retrieves information about one or more code review jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a code review job.

Link copied to clipboard

Retrieves information about one or more code reviews in an agent space.

Link copied to clipboard

Retrieves information about one or more security findings in an agent space.

Link copied to clipboard

Retrieves information about one or more pentest jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a pentest job.

Link copied to clipboard

Retrieves information about one or more pentests in an agent space.

Link copied to clipboard

Batch retrieves security requirements from a pack.

Link copied to clipboard

Retrieves information about one or more target domains.

Link copied to clipboard

Retrieves information about one or more threat model jobs in an agent space.

Link copied to clipboard

Retrieves information about one or more tasks within a threat model job.

Link copied to clipboard

Retrieves information about one or more threat models in an agent space.

Link copied to clipboard

Retrieves information about one or more threats.

Link copied to clipboard

Batch updates security requirements within a customer managed pack.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

Link copied to clipboard

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

Link copied to clipboard

Creates a new code review configuration in an agent space. A code review defines the parameters for automated security-focused code analysis.

Link copied to clipboard

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

Link copied to clipboard

Creates a new membership, granting a user access to an agent space within an application.

Link copied to clipboard

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

Link copied to clipboard

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

Link copied to clipboard

Creates a customer managed security requirement pack.

Link copied to clipboard

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

Link copied to clipboard

Creates a new threat under a threat model job.

Link copied to clipboard

Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis.

Link copied to clipboard

Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts.

Link copied to clipboard

Deletes an application and its associated configuration, including IAM Identity Center settings.

Link copied to clipboard

Deletes an artifact from an agent space.

Link copied to clipboard

Deletes an integration with a third-party provider.

Link copied to clipboard

Deletes a membership, revoking a user's access to an agent space.

Link copied to clipboard

Deletes a private connection.

Link copied to clipboard

Deletes a customer managed security requirement pack and all its associated security requirements.

Link copied to clipboard

Deletes a target domain registration. After deletion, the domain can no longer be used for penetration testing.

Link copied to clipboard

Retrieves the details of a private connection.

Link copied to clipboard

Retrieves information about an application.

Link copied to clipboard

Retrieves an artifact from an agent space.

Link copied to clipboard

Retrieves information about an integration.

Link copied to clipboard

Retrieves information about a security requirement pack.

Link copied to clipboard

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

Link copied to clipboard

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

Link copied to clipboard

Returns a paginated list of agent space summaries in your account.

Link copied to clipboard

Returns a paginated list of application summaries in your account.

Link copied to clipboard

Returns a paginated list of artifact summaries for the specified agent space.

Link copied to clipboard

Returns a paginated list of code review job summaries for the specified code review configuration.

Link copied to clipboard

Returns a paginated list of task summaries for the specified code review job, optionally filtered by step name or category.

Link copied to clipboard

Returns a paginated list of code review summaries for the specified agent space.

Link copied to clipboard

Returns a paginated list of endpoints discovered during a pentest job execution.

Link copied to clipboard

Lists the security findings for a pentest job.

Link copied to clipboard

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

Link copied to clipboard

Lists the integrations in your account, optionally filtered by provider or provider type.

Link copied to clipboard

Returns a paginated list of membership summaries for the specified agent space within an application.

Link copied to clipboard

Returns a paginated list of pentest job summaries for the specified pentest configuration.

Link copied to clipboard

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Link copied to clipboard

Returns a paginated list of pentest summaries for the specified agent space.

Link copied to clipboard

Lists the private connections in your account.

Link copied to clipboard

Lists all security requirement packs in the caller's account.

Link copied to clipboard

Lists security requirements within a pack.

Link copied to clipboard

Returns the tags associated with the specified resource.

Link copied to clipboard

Returns a paginated list of target domain summaries in your account.

Link copied to clipboard

Returns a paginated list of threat model job summaries for the specified threat model.

Link copied to clipboard

Returns a paginated list of task summaries for the specified threat model job.

Link copied to clipboard

Returns a paginated list of threat model summaries for the specified agent space.

Link copied to clipboard

Returns a paginated list of threats for a threat model job.

Link copied to clipboard

Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.

Link copied to clipboard

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

Link copied to clipboard

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

Link copied to clipboard

Starts a new threat model job for a threat model configuration.

Link copied to clipboard

Stops a running code review job. The job transitions to a stopping state and then to stopped after cleanup completes.

Link copied to clipboard

Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.

Link copied to clipboard

Stops a running threat model job.

Link copied to clipboard

Adds tags to a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.

Link copied to clipboard

Updates the configuration of an existing application, including the IAM role and default KMS key.

Link copied to clipboard

Updates an existing code review configuration.

Link copied to clipboard

Updates the status or risk level of a security finding.

Link copied to clipboard

Updates the integrated resources for an agent space, including their capabilities.

Link copied to clipboard

Updates an existing pentest configuration.

Link copied to clipboard

Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.

Link copied to clipboard

Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.

Link copied to clipboard

Updates the verification method for a target domain.

Link copied to clipboard

Updates a threat.

Link copied to clipboard

Updates an existing threat model configuration.

Link copied to clipboard

Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.