View Source AWS.SecurityAgent (aws-elixir v1.0.13)

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.

Link to this section Summary

Functions

Uploads an artifact to an agent space.

Batch creates security requirements in a customer managed pack.

Deletes one or more code reviews from an agent space.

Deletes one or more pentests from an agent space.

Batch deletes security requirements from a customer managed pack.

Deletes one or more threat models from an agent space.

Retrieves information about one or more agent spaces.

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

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

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

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

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

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

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

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

Batch retrieves security requirements from a pack.

Retrieves information about one or more target domains.

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

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

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

Retrieves information about one or more threats.

Batch updates security requirements within a customer managed pack.

Creates a new code review configuration in an agent space.

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

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

Creates a new pentest configuration in an agent space.

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

Creates a customer managed security requirement pack.

Creates a new target domain for penetration testing.

Creates a new threat under a threat model job.

Creates a new threat model configuration in an agent space.

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

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

Deletes an artifact from an agent space.

Deletes an integration with a third-party provider.

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

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

Deletes a target domain registration.

Retrieves the details of a private connection.

Retrieves information about an application.

Retrieves an artifact from an agent space.

Retrieves information about an integration.

Retrieves information about a security requirement pack.

Imports security requirements from uploaded documents into a customer managed security requirement pack.

Initiates the OAuth registration flow with a third-party provider.

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

Returns a paginated list of application summaries in your account.

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

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

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

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

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

Lists the security findings for a pentest job.

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

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

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

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

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

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

Lists the private connections in your account.

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

Lists security requirements within a pack.

Returns the tags associated with the specified resource.

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

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

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

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

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

Initiates code remediation for one or more security findings.

Starts a new code review job for a code review configuration.

Starts a new pentest job for a pentest configuration.

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

Stops a running code review job.

Stops a running pentest job.

Stops a running threat model job.

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

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

Updates an existing code review configuration.

Updates the status or risk level of a security finding.

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

Updates an existing pentest configuration.

Updates the certificate associated with a private connection.

Updates the verification method for a target domain.

Updates an existing threat model configuration.

Initiates verification of a target domain.

Link to this section Functions

Link to this function

add_artifact(client, input, options \\ [])

View Source

Uploads an artifact to an agent space.

Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

Link to this function

batch_create_security_requirements(client, input, options \\ [])

View Source

Batch creates security requirements in a customer managed pack.

Link to this function

batch_delete_code_reviews(client, input, options \\ [])

View Source

Deletes one or more code reviews from an agent space.

Link to this function

batch_delete_pentests(client, input, options \\ [])

View Source

Deletes one or more pentests from an agent space.

Link to this function

batch_delete_security_requirements(client, input, options \\ [])

View Source

Batch deletes security requirements from a customer managed pack.

Link to this function

batch_delete_threat_models(client, input, options \\ [])

View Source

Deletes one or more threat models from an agent space.

Link to this function

batch_get_agent_spaces(client, input, options \\ [])

View Source

Retrieves information about one or more agent spaces.

Link to this function

batch_get_artifact_metadata(client, input, options \\ [])

View Source

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

Link to this function

batch_get_code_review_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

batch_get_code_review_jobs(client, input, options \\ [])

View Source

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

Link to this function

batch_get_code_reviews(client, input, options \\ [])

View Source

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

Link to this function

batch_get_findings(client, input, options \\ [])

View Source

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

Link to this function

batch_get_pentest_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

batch_get_pentest_jobs(client, input, options \\ [])

View Source

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

Link to this function

batch_get_pentests(client, input, options \\ [])

View Source

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

Link to this function

batch_get_security_requirements(client, input, options \\ [])

View Source

Batch retrieves security requirements from a pack.

Link to this function

batch_get_target_domains(client, input, options \\ [])

View Source

Retrieves information about one or more target domains.

Link to this function

batch_get_threat_model_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

batch_get_threat_model_jobs(client, input, options \\ [])

View Source

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

Link to this function

batch_get_threat_models(client, input, options \\ [])

View Source

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

Link to this function

batch_get_threats(client, input, options \\ [])

View Source

Retrieves information about one or more threats.

Link to this function

batch_update_security_requirements(client, input, options \\ [])

View Source

Batch updates security requirements within a customer managed pack.

Link to this function

create_agent_space(client, input, options \\ [])

View Source

Creates a new agent space.

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

Link to this function

create_application(client, input, options \\ [])

View Source

Creates a new application.

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

Link to this function

create_code_review(client, input, options \\ [])

View Source

Creates a new code review configuration in an agent space.

A code review defines the parameters for automated security-focused code analysis.

Link to this function

create_integration(client, input, options \\ [])

View Source

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

Link to this function

create_membership(client, input, options \\ [])

View Source

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

Link to this function

create_pentest(client, input, options \\ [])

View Source

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 to this function

create_private_connection(client, input, options \\ [])

View Source

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

Link to this function

create_security_requirement_pack(client, input, options \\ [])

View Source

Creates a customer managed security requirement pack.

Link to this function

create_target_domain(client, input, options \\ [])

View Source

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 to this function

create_threat(client, input, options \\ [])

View Source

Creates a new threat under a threat model job.

Link to this function

create_threat_model(client, input, options \\ [])

View Source

Creates a new threat model configuration in an agent space.

A threat model defines the parameters for automated threat analysis.

Link to this function

delete_agent_space(client, input, options \\ [])

View Source

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

Link to this function

delete_application(client, input, options \\ [])

View Source

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

Link to this function

delete_artifact(client, input, options \\ [])

View Source

Deletes an artifact from an agent space.

Link to this function

delete_integration(client, input, options \\ [])

View Source

Deletes an integration with a third-party provider.

Link to this function

delete_membership(client, input, options \\ [])

View Source

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

Link to this function

delete_private_connection(client, input, options \\ [])

View Source

Deletes a private connection.

Link to this function

delete_security_requirement_pack(client, input, options \\ [])

View Source

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

Link to this function

delete_target_domain(client, input, options \\ [])

View Source

Deletes a target domain registration.

After deletion, the domain can no longer be used for penetration testing.

Link to this function

describe_private_connection(client, input, options \\ [])

View Source

Retrieves the details of a private connection.

Link to this function

get_application(client, input, options \\ [])

View Source

Retrieves information about an application.

Link to this function

get_artifact(client, input, options \\ [])

View Source

Retrieves an artifact from an agent space.

Link to this function

get_integration(client, input, options \\ [])

View Source

Retrieves information about an integration.

Link to this function

get_security_requirement_pack(client, input, options \\ [])

View Source

Retrieves information about a security requirement pack.

Link to this function

import_security_requirements(client, input, options \\ [])

View Source

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 to this function

initiate_provider_registration(client, input, options \\ [])

View Source

Initiates the OAuth registration flow with a third-party provider.

Returns a redirect URL and CSRF state token for completing the authorization.

Link to this function

list_agent_spaces(client, input, options \\ [])

View Source

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

Link to this function

list_applications(client, input, options \\ [])

View Source

Returns a paginated list of application summaries in your account.

Link to this function

list_artifacts(client, input, options \\ [])

View Source

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

Link to this function

list_code_review_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

list_code_review_jobs_for_code_review(client, input, options \\ [])

View Source

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

Link to this function

list_code_reviews(client, input, options \\ [])

View Source

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

Link to this function

list_discovered_endpoints(client, input, options \\ [])

View Source

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

Link to this function

list_findings(client, input, options \\ [])

View Source

Lists the security findings for a pentest job.

Link to this function

list_integrated_resources(client, input, options \\ [])

View Source

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

Link to this function

list_integrations(client, input, options \\ [])

View Source

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

Link to this function

list_memberships(client, input, options \\ [])

View Source

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

Link to this function

list_pentest_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

list_pentest_jobs_for_pentest(client, input, options \\ [])

View Source

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

Link to this function

list_pentests(client, input, options \\ [])

View Source

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

Link to this function

list_private_connections(client, input, options \\ [])

View Source

Lists the private connections in your account.

Link to this function

list_security_requirement_packs(client, input, options \\ [])

View Source

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

Link to this function

list_security_requirements(client, input, options \\ [])

View Source

Lists security requirements within a pack.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns the tags associated with the specified resource.

Link to this function

list_target_domains(client, input, options \\ [])

View Source

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

Link to this function

list_threat_model_job_tasks(client, input, options \\ [])

View Source

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

Link to this function

list_threat_model_jobs(client, input, options \\ [])

View Source

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

Link to this function

list_threat_models(client, input, options \\ [])

View Source

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

Link to this function

list_threats(client, input, options \\ [])

View Source

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

Link to this function

start_code_remediation(client, input, options \\ [])

View Source

Initiates code remediation for one or more security findings.

This creates pull requests in integrated repositories to fix the identified vulnerabilities.

Link to this function

start_code_review_job(client, input, options \\ [])

View Source

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 to this function

start_pentest_job(client, input, options \\ [])

View Source

Starts a new pentest job for a pentest configuration.

The job executes the security tests defined in the pentest.

Link to this function

start_threat_model_job(client, input, options \\ [])

View Source

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

Link to this function

stop_code_review_job(client, input, options \\ [])

View Source

Stops a running code review job.

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

Link to this function

stop_pentest_job(client, input, options \\ [])

View Source

Stops a running pentest job.

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

Link to this function

stop_threat_model_job(client, input, options \\ [])

View Source

Stops a running threat model job.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a resource.

Link to this function

update_agent_space(client, input, options \\ [])

View Source

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

Link to this function

update_application(client, input, options \\ [])

View Source

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

Link to this function

update_code_review(client, input, options \\ [])

View Source

Updates an existing code review configuration.

Link to this function

update_finding(client, input, options \\ [])

View Source

Updates the status or risk level of a security finding.

Link to this function

update_integrated_resources(client, input, options \\ [])

View Source

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

Link to this function

update_pentest(client, input, options \\ [])

View Source

Updates an existing pentest configuration.

Link to this function

update_private_connection_certificate(client, input, options \\ [])

View Source

Updates the certificate associated with a private connection.

Certificates can be added or replaced but not removed.

Link to this function

update_security_requirement_pack(client, input, options \\ [])

View Source

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 to this function

update_target_domain(client, input, options \\ [])

View Source

Updates the verification method for a target domain.

Link to this function

update_threat(client, input, options \\ [])

View Source

Updates a threat.

Link to this function

update_threat_model(client, input, options \\ [])

View Source

Updates an existing threat model configuration.

Link to this function

verify_target_domain(client, input, options \\ [])

View Source

Initiates verification of a target domain.

This checks whether the domain ownership verification token has been properly configured.