Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Security Agent

Client for invoking operations on AWS Security Agent. Each operation on AWS Security Agent is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_securityagent::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_securityagent::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddArtifact operation has a Client::add_artifact, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_artifact()
    .agent_space_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_artifact(&self) -> AddArtifactFluentBuilder

Constructs a fluent builder for the AddArtifact operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to add the artifact to.

    
    
  • artifact_content(Blob) / set_artifact_content(Option<Blob>):
    required: true
    

    The binary content of the artifact to upload.

    
    
  • artifact_type(ArtifactType) / set_artifact_type(Option<ArtifactType>):
    required: true
    

    The file type of the artifact. Valid values include TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, and YAML.

    
    
  • file_name(impl Into<String>) / set_file_name(Option<String>):
    required: true
    

    The file name of the artifact.

    
    
• On success, responds with AddArtifactOutput with field(s):
  • artifact_id(String):

    The unique identifier assigned to the uploaded artifact.

• On failure, responds with SdkError<AddArtifactError>

impl Client

pub fn batch_delete_code_reviews(&self) -> BatchDeleteCodeReviewsFluentBuilder

Constructs a fluent builder for the BatchDeleteCodeReviews operation.

• The fluent builder is configurable:
  • code_review_ids(impl Into<String>) / set_code_review_ids(Option<Vec::<String>>):
    required: true
    

    The list of code review identifiers to delete.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the code reviews to delete.

    
    
• On success, responds with BatchDeleteCodeReviewsOutput with field(s):
  • deleted(Option<Vec::<String>>):

    The list of identifiers of the code reviews that were successfully deleted.

  • failed(Option<Vec::<DeleteCodeReviewFailure>>):

    The list of code reviews that failed to delete, including the reason for each failure.

• On failure, responds with SdkError<BatchDeleteCodeReviewsError>

impl Client

pub fn batch_delete_pentests(&self) -> BatchDeletePentestsFluentBuilder

Constructs a fluent builder for the BatchDeletePentests operation.

• The fluent builder is configurable:
  • pentest_ids(impl Into<String>) / set_pentest_ids(Option<Vec::<String>>):
    required: true
    

    The list of pentest identifiers to delete.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the pentests to delete.

    
    
• On success, responds with BatchDeletePentestsOutput with field(s):
  • deleted(Option<Vec::<Pentest>>):

    The list of pentests that were successfully deleted.

  • failed(Option<Vec::<DeletePentestFailure>>):

    The list of pentests that failed to delete, including the reason for each failure.

• On failure, responds with SdkError<BatchDeletePentestsError>

impl Client

pub fn batch_get_agent_spaces(&self) -> BatchGetAgentSpacesFluentBuilder

Constructs a fluent builder for the BatchGetAgentSpaces operation.

• The fluent builder is configurable:
  • agent_space_ids(impl Into<String>) / set_agent_space_ids(Option<Vec::<String>>):
    required: true
    

    The list of agent space identifiers to retrieve.

    
    
• On success, responds with BatchGetAgentSpacesOutput with field(s):
  • agent_spaces(Option<Vec::<AgentSpace>>):

    The list of agent spaces that were found.

  • not_found(Option<Vec::<String>>):

    The list of agent space identifiers that were not found.

• On failure, responds with SdkError<BatchGetAgentSpacesError>

impl Client

pub fn batch_get_artifact_metadata( &self, ) -> BatchGetArtifactMetadataFluentBuilder

Constructs a fluent builder for the BatchGetArtifactMetadata operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the artifacts.

    
    
  • artifact_ids(impl Into<String>) / set_artifact_ids(Option<Vec::<String>>):
    required: true
    

    The list of artifact identifiers to retrieve metadata for.

    
    
• On success, responds with BatchGetArtifactMetadataOutput with field(s):
  • artifact_metadata_list(Vec::<ArtifactMetadataItem>):

    The list of artifact metadata items that were found.

• On failure, responds with SdkError<BatchGetArtifactMetadataError>

impl Client

pub fn batch_get_code_review_job_tasks( &self, ) -> BatchGetCodeReviewJobTasksFluentBuilder

Constructs a fluent builder for the BatchGetCodeReviewJobTasks operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the tasks.

    
    
  • code_review_job_task_ids(impl Into<String>) / set_code_review_job_task_ids(Option<Vec::<String>>):
    required: true
    

    The list of task identifiers to retrieve.

    
    
• On success, responds with BatchGetCodeReviewJobTasksOutput with field(s):
  • code_review_job_tasks(Option<Vec::<CodeReviewJobTask>>):

    The list of code review job tasks that were found.

  • not_found(Option<Vec::<String>>):

    The list of task identifiers that were not found.

• On failure, responds with SdkError<BatchGetCodeReviewJobTasksError>

impl Client

pub fn batch_get_code_review_jobs(&self) -> BatchGetCodeReviewJobsFluentBuilder

Constructs a fluent builder for the BatchGetCodeReviewJobs operation.

• The fluent builder is configurable:
  • code_review_job_ids(impl Into<String>) / set_code_review_job_ids(Option<Vec::<String>>):
    required: true
    

    The list of code review job identifiers to retrieve.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the code review jobs.

    
    
• On success, responds with BatchGetCodeReviewJobsOutput with field(s):
  • code_review_jobs(Option<Vec::<CodeReviewJob>>):

    The list of code review jobs that were found.

  • not_found(Option<Vec::<String>>):

    The list of code review job identifiers that were not found.

• On failure, responds with SdkError<BatchGetCodeReviewJobsError>

impl Client

pub fn batch_get_code_reviews(&self) -> BatchGetCodeReviewsFluentBuilder

Constructs a fluent builder for the BatchGetCodeReviews operation.

• The fluent builder is configurable:
  • code_review_ids(impl Into<String>) / set_code_review_ids(Option<Vec::<String>>):
    required: true
    

    The list of code review identifiers to retrieve.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the code reviews.

    
    
• On success, responds with BatchGetCodeReviewsOutput with field(s):
  • code_reviews(Option<Vec::<CodeReview>>):

    The list of code reviews that were found.

  • not_found(Option<Vec::<String>>):

    The list of code review identifiers that were not found.

• On failure, responds with SdkError<BatchGetCodeReviewsError>

impl Client

pub fn batch_get_findings(&self) -> BatchGetFindingsFluentBuilder

Constructs a fluent builder for the BatchGetFindings operation.

• The fluent builder is configurable:
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The list of finding identifiers to retrieve.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the findings.

    
    
• On success, responds with BatchGetFindingsOutput with field(s):
  • findings(Option<Vec::<Finding>>):

    The list of findings that were found.

  • not_found(Option<Vec::<String>>):

    The list of finding identifiers that were not found.

• On failure, responds with SdkError<BatchGetFindingsError>

impl Client

pub fn batch_get_pentest_job_tasks( &self, ) -> BatchGetPentestJobTasksFluentBuilder

Constructs a fluent builder for the BatchGetPentestJobTasks operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the tasks.

    
    
  • task_ids(impl Into<String>) / set_task_ids(Option<Vec::<String>>):
    required: true
    

    The list of task identifiers to retrieve.

    
    
• On success, responds with BatchGetPentestJobTasksOutput with field(s):
  • tasks(Option<Vec::<Task>>):

    The list of tasks that were found.

  • not_found(Option<Vec::<String>>):

    The list of task identifiers that were not found.

• On failure, responds with SdkError<BatchGetPentestJobTasksError>

impl Client

pub fn batch_get_pentest_jobs(&self) -> BatchGetPentestJobsFluentBuilder

Constructs a fluent builder for the BatchGetPentestJobs operation.

• The fluent builder is configurable:
  • pentest_job_ids(impl Into<String>) / set_pentest_job_ids(Option<Vec::<String>>):
    required: true
    

    The list of pentest job identifiers to retrieve.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the pentest jobs.

    
    
• On success, responds with BatchGetPentestJobsOutput with field(s):
  • pentest_jobs(Option<Vec::<PentestJob>>):

    The list of pentest jobs that were found.

  • not_found(Option<Vec::<String>>):

    The list of pentest job identifiers that were not found.

• On failure, responds with SdkError<BatchGetPentestJobsError>

impl Client

pub fn batch_get_pentests(&self) -> BatchGetPentestsFluentBuilder

Constructs a fluent builder for the BatchGetPentests operation.

• The fluent builder is configurable:
  • pentest_ids(impl Into<String>) / set_pentest_ids(Option<Vec::<String>>):
    required: true
    

    The list of pentest identifiers to retrieve.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the pentests.

    
    
• On success, responds with BatchGetPentestsOutput with field(s):
  • pentests(Option<Vec::<Pentest>>):

    The list of pentests that were found.

  • not_found(Option<Vec::<String>>):

    The list of pentest identifiers that were not found.

• On failure, responds with SdkError<BatchGetPentestsError>

impl Client

pub fn batch_get_target_domains(&self) -> BatchGetTargetDomainsFluentBuilder

Constructs a fluent builder for the BatchGetTargetDomains operation.

• The fluent builder is configurable:
  • target_domain_ids(impl Into<String>) / set_target_domain_ids(Option<Vec::<String>>):
    required: true
    

    The list of target domain identifiers to retrieve.

    
    
• On success, responds with BatchGetTargetDomainsOutput with field(s):
  • target_domains(Option<Vec::<TargetDomain>>):

    The list of target domains that were found.

  • not_found(Option<Vec::<String>>):

    The list of target domain identifiers that were not found.

• On failure, responds with SdkError<BatchGetTargetDomainsError>

impl Client

pub fn create_agent_space(&self) -> CreateAgentSpaceFluentBuilder

Constructs a fluent builder for the CreateAgentSpace operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the agent space.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the agent space.

    
    
  • aws_resources(AwsResources) / set_aws_resources(Option<AwsResources>):
    required: false
    

    The AWS resources to associate with the agent space.

    
    
  • target_domain_ids(impl Into<String>) / set_target_domain_ids(Option<Vec::<String>>):
    required: false
    

    The list of target domain identifiers to associate with the agent space.

    
    
  • code_review_settings(CodeReviewSettings) / set_code_review_settings(Option<CodeReviewSettings>):
    required: false
    

    The code review settings for the agent space.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The identifier of the AWS KMS key to use for encrypting data in the agent space.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to associate with the agent space.

    
    
• On success, responds with CreateAgentSpaceOutput with field(s):
  • agent_space_id(String):

    The unique identifier of the created agent space.

  • name(String):

    The name of the agent space.

  • description(Option<String>):

    The description of the agent space.

  • aws_resources(Option<AwsResources>):

    The AWS resources associated with the agent space.

  • target_domain_ids(Option<Vec::<String>>):

    The list of target domain identifiers associated with the agent space.

  • code_review_settings(Option<CodeReviewSettings>):

    The code review settings for the agent space.

  • kms_key_id(Option<String>):

    The identifier of the AWS KMS key used to encrypt data in the agent space.

  • created_at(Option<DateTime>):

    The date and time the agent space was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the agent space was last updated, in UTC format.

• On failure, responds with SdkError<CreateAgentSpaceError>

impl Client

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

• The fluent builder is configurable:
  • idc_instance_arn(impl Into<String>) / set_idc_instance_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the application.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role to associate with the application.

    
    
  • default_kms_key_id(impl Into<String>) / set_default_kms_key_id(Option<String>):
    required: false
    

    The identifier of the default AWS KMS key to use for encrypting data in the application.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to associate with the application.

    
    
• On success, responds with CreateApplicationOutput with field(s):
  • application_id(String):

    The unique identifier of the created application.

• On failure, responds with SdkError<CreateApplicationError>

impl Client

pub fn create_code_review(&self) -> CreateCodeReviewFluentBuilder

Constructs a fluent builder for the CreateCodeReview operation.

• The fluent builder is configurable:
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    The title of the code review.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to create the code review in.

    
    
  • assets(Assets) / set_assets(Option<Assets>):
    required: true
    

    The assets to include in the code review, such as documents and source code.

    
    
  • service_role(impl Into<String>) / set_service_role(Option<String>):
    required: false
    

    The IAM service role to use for the code review.

    
    
  • log_config(CloudWatchLog) / set_log_config(Option<CloudWatchLog>):
    required: false
    

    The CloudWatch Logs configuration for the code review.

    
    
  • code_remediation_strategy(CodeRemediationStrategy) / set_code_remediation_strategy(Option<CodeRemediationStrategy>):
    required: false
    

    The code remediation strategy for the code review. Valid values are AUTOMATIC and DISABLED.

    
    
• On success, responds with CreateCodeReviewOutput with field(s):
  • code_review_id(String):

    The unique identifier of the created code review.

  • title(Option<String>):

    The title of the code review.

  • created_at(Option<DateTime>):

    The date and time the code review was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the code review was last updated, in UTC format.

  • assets(Option<Assets>):

    The assets included in the code review.

  • service_role(Option<String>):

    The IAM service role used for the code review.

  • log_config(Option<CloudWatchLog>):

    The CloudWatch Logs configuration for the code review.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space that contains the code review.

  • code_remediation_strategy(Option<CodeRemediationStrategy>):

    The code remediation strategy for the code review.

• On failure, responds with SdkError<CreateCodeReviewError>

impl Client

pub fn create_integration(&self) -> CreateIntegrationFluentBuilder

Constructs a fluent builder for the CreateIntegration operation.

• The fluent builder is configurable:
  • provider(Provider) / set_provider(Option<Provider>):
    required: true
    

    The integration provider. Currently, only GITHUB is supported.

    
    
  • input(ProviderInput) / set_input(Option<ProviderInput>):
    required: true
    

    The provider-specific input required to create the integration.

    
    
  • integration_display_name(impl Into<String>) / set_integration_display_name(Option<String>):
    required: true
    

    The display name for the integration.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The identifier of the AWS KMS key to use for encrypting data associated with the integration.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to associate with the integration.

    
    
• On success, responds with CreateIntegrationOutput with field(s):
  • integration_id(String):

    The unique identifier of the created integration.

• On failure, responds with SdkError<CreateIntegrationError>

impl Client

pub fn create_membership(&self) -> CreateMembershipFluentBuilder

Constructs a fluent builder for the CreateMembership operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application that contains the agent space.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to grant access to.

    
    
  • membership_id(impl Into<String>) / set_membership_id(Option<String>):
    required: true
    

    The unique identifier for the membership.

    
    
  • member_type(MembershipType) / set_member_type(Option<MembershipType>):
    required: true
    

    The type of member. Currently, only USER is supported.

    
    
  • config(MembershipConfig) / set_config(Option<MembershipConfig>):
    required: false
    

    The configuration for the membership, such as the user role.

    
    
• On success, responds with CreateMembershipOutput
• On failure, responds with SdkError<CreateMembershipError>

impl Client

pub fn create_pentest(&self) -> CreatePentestFluentBuilder

Constructs a fluent builder for the CreatePentest operation.

• The fluent builder is configurable:
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    The title of the pentest.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to create the pentest in.

    
    
  • assets(Assets) / set_assets(Option<Assets>):
    required: false
    

    The assets to include in the pentest, such as endpoints, actors, documents, and source code.

    
    
  • exclude_risk_types(RiskType) / set_exclude_risk_types(Option<Vec::<RiskType>>):
    required: false
    

    The list of risk types to exclude from the pentest.

    
    
  • service_role(impl Into<String>) / set_service_role(Option<String>):
    required: false
    

    The IAM service role to use for the pentest.

    
    
  • log_config(CloudWatchLog) / set_log_config(Option<CloudWatchLog>):
    required: false
    

    The CloudWatch Logs configuration for the pentest.

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

    The VPC configuration for the pentest.

    
    
  • network_traffic_config(NetworkTrafficConfig) / set_network_traffic_config(Option<NetworkTrafficConfig>):
    required: false
    

    The network traffic configuration for the pentest, including custom headers and traffic rules.

    
    
  • code_remediation_strategy(CodeRemediationStrategy) / set_code_remediation_strategy(Option<CodeRemediationStrategy>):
    required: false
    

    The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

    
    
• On success, responds with CreatePentestOutput with field(s):
  • pentest_id(Option<String>):

    The unique identifier of the created pentest.

  • title(Option<String>):

    The title of the pentest.

  • created_at(Option<DateTime>):

    The date and time the pentest was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the pentest was last updated, in UTC format.

  • assets(Option<Assets>):

    The assets included in the pentest.

  • exclude_risk_types(Option<Vec::<RiskType>>):

    The list of risk types excluded from the pentest.

  • service_role(Option<String>):

    The IAM service role used for the pentest.

  • log_config(Option<CloudWatchLog>):

    The CloudWatch Logs configuration for the pentest.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space that contains the pentest.

• On failure, responds with SdkError<CreatePentestError>

impl Client

pub fn create_target_domain(&self) -> CreateTargetDomainFluentBuilder

Constructs a fluent builder for the CreateTargetDomain operation.

• The fluent builder is configurable:
  • target_domain_name(impl Into<String>) / set_target_domain_name(Option<String>):
    required: true
    

    The domain name to register as a target domain.

    
    
  • verification_method(DomainVerificationMethod) / set_verification_method(Option<DomainVerificationMethod>):
    required: true
    

    The method to use for verifying domain ownership. Valid values are DNS_TXT, HTTP_ROUTE, and PRIVATE_VPC.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to associate with the target domain.

    
    
• On success, responds with CreateTargetDomainOutput with field(s):
  • target_domain_id(String):

    The unique identifier of the created target domain.

  • domain_name(String):

    The domain name of the target domain.

  • verification_status(TargetDomainStatus):

    The current verification status of the target domain.

  • verification_status_reason(Option<String>):

    The reason for the current target domain verification status.

  • verification_details(Option<VerificationDetails>):

    The verification details for the target domain, including the verification token and instructions.

  • created_at(Option<DateTime>):

    The date and time the target domain was created, in UTC format.

  • verified_at(Option<DateTime>):

    The date and time the target domain was verified, in UTC format.

• On failure, responds with SdkError<CreateTargetDomainError>

impl Client

pub fn delete_agent_space(&self) -> DeleteAgentSpaceFluentBuilder

Constructs a fluent builder for the DeleteAgentSpace operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to delete.

    
    
• On success, responds with DeleteAgentSpaceOutput with field(s):
  • agent_space_id(Option<String>):

    The unique identifier of the deleted agent space.

• On failure, responds with SdkError<DeleteAgentSpaceError>

impl Client

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application to delete.

    
    
• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

impl Client

pub fn delete_artifact(&self) -> DeleteArtifactFluentBuilder

Constructs a fluent builder for the DeleteArtifact operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the artifact.

    
    
  • artifact_id(impl Into<String>) / set_artifact_id(Option<String>):
    required: true
    

    The unique identifier of the artifact to delete.

    
    
• On success, responds with DeleteArtifactOutput
• On failure, responds with SdkError<DeleteArtifactError>

impl Client

pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder

Constructs a fluent builder for the DeleteIntegration operation.

• The fluent builder is configurable:
  • integration_id(impl Into<String>) / set_integration_id(Option<String>):
    required: true
    

    The unique identifier of the integration to delete.

    
    
• On success, responds with DeleteIntegrationOutput
• On failure, responds with SdkError<DeleteIntegrationError>

impl Client

pub fn delete_membership(&self) -> DeleteMembershipFluentBuilder

Constructs a fluent builder for the DeleteMembership operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application that contains the agent space.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to revoke access from.

    
    
  • membership_id(impl Into<String>) / set_membership_id(Option<String>):
    required: true
    

    The unique identifier of the membership to delete.

    
    
  • member_type(MembershipType) / set_member_type(Option<MembershipType>):
    required: false
    

    The type of member to remove.

    
    
• On success, responds with DeleteMembershipOutput
• On failure, responds with SdkError<DeleteMembershipError>

impl Client

pub fn delete_target_domain(&self) -> DeleteTargetDomainFluentBuilder

Constructs a fluent builder for the DeleteTargetDomain operation.

• The fluent builder is configurable:
  • target_domain_id(impl Into<String>) / set_target_domain_id(Option<String>):
    required: true
    

    The unique identifier of the target domain to delete.

    
    
• On success, responds with DeleteTargetDomainOutput with field(s):
  • target_domain_id(Option<String>):

    The unique identifier of the deleted target domain.

• On failure, responds with SdkError<DeleteTargetDomainError>

impl Client

pub fn get_application(&self) -> GetApplicationFluentBuilder

Constructs a fluent builder for the GetApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application to retrieve.

    
    
• On success, responds with GetApplicationOutput with field(s):
  • application_id(String):

    The unique identifier of the application.

  • domain(String):

    The domain associated with the application.

  • application_name(Option<String>):

    The name of the application.

  • idc_configuration(Option<IdCConfiguration>):

    The IAM Identity Center configuration for the application.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role associated with the application.

  • default_kms_key_id(Option<String>):

    The identifier of the default AWS KMS key used to encrypt data for the application.

• On failure, responds with SdkError<GetApplicationError>

impl Client

pub fn get_artifact(&self) -> GetArtifactFluentBuilder

Constructs a fluent builder for the GetArtifact operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the artifact.

    
    
  • artifact_id(impl Into<String>) / set_artifact_id(Option<String>):
    required: true
    

    The unique identifier of the artifact to retrieve.

    
    
• On success, responds with GetArtifactOutput with field(s):
  • agent_space_id(String):

    The unique identifier of the agent space that contains the artifact.

  • artifact_id(String):

    The unique identifier of the artifact.

  • artifact(Option<Artifact>):

    The artifact content and type.

  • file_name(String):

    The file name of the artifact.

  • updated_at(DateTime):

    The date and time the artifact was last updated, in UTC format.

• On failure, responds with SdkError<GetArtifactError>

impl Client

pub fn get_integration(&self) -> GetIntegrationFluentBuilder

Constructs a fluent builder for the GetIntegration operation.

• The fluent builder is configurable:
  • integration_id(impl Into<String>) / set_integration_id(Option<String>):
    required: true
    

    The unique identifier of the integration to retrieve.

    
    
• On success, responds with GetIntegrationOutput with field(s):
  • integration_id(String):

    The unique identifier of the integration.

  • installation_id(String):

    The installation identifier from the integration provider.

  • provider(Provider):

    The integration provider.

  • provider_type(ProviderType):

    The type of the integration provider.

  • display_name(Option<String>):

    The display name of the integration.

  • kms_key_id(Option<String>):

    The identifier of the AWS KMS key used to encrypt data associated with the integration.

• On failure, responds with SdkError<GetIntegrationError>

impl Client

pub fn initiate_provider_registration( &self, ) -> InitiateProviderRegistrationFluentBuilder

Constructs a fluent builder for the InitiateProviderRegistration operation.

• The fluent builder is configurable:
  • provider(Provider) / set_provider(Option<Provider>):
    required: true
    

    The provider to initiate registration with. Currently, only GITHUB is supported.

    
    
• On success, responds with InitiateProviderRegistrationOutput with field(s):
  • redirect_to(String):

    The URL to redirect the user to for completing the OAuth authorization.

  • csrf_state(String):

    The CSRF state token to use when completing the OAuth flow.

• On failure, responds with SdkError<InitiateProviderRegistrationError>

impl Client

pub fn list_agent_spaces(&self) -> ListAgentSpacesFluentBuilder

Constructs a fluent builder for the ListAgentSpaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListAgentSpacesOutput with field(s):
  • agent_space_summaries(Option<Vec::<AgentSpaceSummary>>):

    The list of agent space summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListAgentSpacesError>

impl Client

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

Constructs a fluent builder for the ListApplications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListApplicationsOutput with field(s):
  • application_summaries(Vec::<ApplicationSummary>):

    The list of application summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListApplicationsError>

impl Client

pub fn list_artifacts(&self) -> ListArtifactsFluentBuilder

Constructs a fluent builder for the ListArtifacts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to list artifacts for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListArtifactsOutput with field(s):
  • artifact_summaries(Vec::<ArtifactSummary>):

    The list of artifact summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListArtifactsError>

impl Client

pub fn list_code_review_job_tasks(&self) -> ListCodeReviewJobTasksFluentBuilder

Constructs a fluent builder for the ListCodeReviewJobTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • code_review_job_id(impl Into<String>) / set_code_review_job_id(Option<String>):
    required: false
    

    The unique identifier of the code review job to list tasks for.

    
    
  • step_name(StepName) / set_step_name(Option<StepName>):
    required: false
    

    Filter tasks by step name.

    
    
  • category_name(impl Into<String>) / set_category_name(Option<String>):
    required: false
    

    Filter tasks by category name.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListCodeReviewJobTasksOutput with field(s):
  • code_review_job_task_summaries(Option<Vec::<CodeReviewJobTaskSummary>>):

    The list of code review job task summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListCodeReviewJobTasksError>

impl Client

pub fn list_code_review_jobs_for_code_review( &self, ) -> ListCodeReviewJobsForCodeReviewFluentBuilder

Constructs a fluent builder for the ListCodeReviewJobsForCodeReview operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • code_review_id(impl Into<String>) / set_code_review_id(Option<String>):
    required: true
    

    The unique identifier of the code review to list jobs for.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListCodeReviewJobsForCodeReviewOutput with field(s):
  • code_review_job_summaries(Option<Vec::<CodeReviewJobSummary>>):

    The list of code review job summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListCodeReviewJobsForCodeReviewError>

impl Client

pub fn list_code_reviews(&self) -> ListCodeReviewsFluentBuilder

Constructs a fluent builder for the ListCodeReviews operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to list code reviews for.

    
    
• On success, responds with ListCodeReviewsOutput with field(s):
  • code_review_summaries(Option<Vec::<CodeReviewSummary>>):

    The list of code review summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListCodeReviewsError>

impl Client

pub fn list_discovered_endpoints(&self) -> ListDiscoveredEndpointsFluentBuilder

Constructs a fluent builder for the ListDiscoveredEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • pentest_job_id(impl Into<String>) / set_pentest_job_id(Option<String>):
    required: true
    

    The unique identifier of the pentest job to list discovered endpoints for.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • prefix(impl Into<String>) / set_prefix(Option<String>):
    required: false
    

    A prefix to filter discovered endpoints by URI.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListDiscoveredEndpointsOutput with field(s):
  • discovered_endpoints(Option<Vec::<DiscoveredEndpoint>>):

    The list of discovered endpoints.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListDiscoveredEndpointsError>

impl Client

pub fn list_findings(&self) -> ListFindingsFluentBuilder

Constructs a fluent builder for the ListFindings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • pentest_job_id(impl Into<String>) / set_pentest_job_id(Option<String>):
    required: false
    

    The unique identifier of the pentest job to list findings for.

    
    
  • code_review_job_id(impl Into<String>) / set_code_review_job_id(Option<String>):
    required: false
    

    The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • risk_type(impl Into<String>) / set_risk_type(Option<String>):
    required: false
    

    Filter findings by risk type.

    
    
  • risk_level(RiskLevel) / set_risk_level(Option<RiskLevel>):
    required: false
    

    Filter findings by risk level.

    
    
  • status(FindingStatus) / set_status(Option<FindingStatus>):
    required: false
    

    Filter findings by status.

    
    
  • confidence(ConfidenceLevel) / set_confidence(Option<ConfidenceLevel>):
    required: false
    

    Filter findings by confidence level.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Filter findings by name.

    
    
• On success, responds with ListFindingsOutput with field(s):
  • findings_summaries(Option<Vec::<FindingSummary>>):

    The list of finding summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListFindingsError>

impl Client

pub fn list_integrated_resources(&self) -> ListIntegratedResourcesFluentBuilder

Constructs a fluent builder for the ListIntegratedResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to list integrated resources for.

    
    
  • integration_id(impl Into<String>) / set_integration_id(Option<String>):
    required: false
    

    The unique identifier of the integration to filter by.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: false
    

    The type of resource to filter by.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListIntegratedResourcesOutput with field(s):
  • integrated_resource_summaries(Vec::<IntegratedResourceSummary>):

    The list of integrated resource summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListIntegratedResourcesError>

impl Client

pub fn list_integrations(&self) -> ListIntegrationsFluentBuilder

Constructs a fluent builder for the ListIntegrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(IntegrationFilter) / set_filter(Option<IntegrationFilter>):
    required: false
    

    A filter to apply to the list of integrations.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListIntegrationsOutput with field(s):
  • integration_summaries(Vec::<IntegrationSummary>):

    The list of integration summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListIntegrationsError>

impl Client

pub fn list_memberships(&self) -> ListMembershipsFluentBuilder

Constructs a fluent builder for the ListMemberships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application that contains the agent space.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to list memberships for.

    
    
  • member_type(MembershipTypeFilter) / set_member_type(Option<MembershipTypeFilter>):
    required: false
    

    Filter memberships by member type.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListMembershipsOutput with field(s):
  • membership_summaries(Vec::<MembershipSummary>):

    The list of membership summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListMembershipsError>

impl Client

pub fn list_pentest_job_tasks(&self) -> ListPentestJobTasksFluentBuilder

Constructs a fluent builder for the ListPentestJobTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • pentest_job_id(impl Into<String>) / set_pentest_job_id(Option<String>):
    required: false
    

    The unique identifier of the pentest job to list tasks for.

    
    
  • step_name(StepName) / set_step_name(Option<StepName>):
    required: false
    

    Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

    
    
  • category_name(impl Into<String>) / set_category_name(Option<String>):
    required: false
    

    Filter tasks by category name.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListPentestJobTasksOutput with field(s):
  • task_summaries(Option<Vec::<TaskSummary>>):

    The list of task summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListPentestJobTasksError>

impl Client

pub fn list_pentest_jobs_for_pentest( &self, ) -> ListPentestJobsForPentestFluentBuilder

Constructs a fluent builder for the ListPentestJobsForPentest operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • pentest_id(impl Into<String>) / set_pentest_id(Option<String>):
    required: true
    

    The unique identifier of the pentest to list jobs for.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
• On success, responds with ListPentestJobsForPentestOutput with field(s):
  • pentest_job_summaries(Option<Vec::<PentestJobSummary>>):

    The list of pentest job summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListPentestJobsForPentestError>

impl Client

pub fn list_pentests(&self) -> ListPentestsFluentBuilder

Constructs a fluent builder for the ListPentests operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to list pentests for.

    
    
• On success, responds with ListPentestsOutput with field(s):
  • pentest_summaries(Option<Vec::<PentestSummary>>):

    The list of pentest summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListPentestsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to list tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_target_domains(&self) -> ListTargetDomainsFluentBuilder

Constructs a fluent builder for the ListTargetDomains operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListTargetDomainsOutput with field(s):
  • target_domain_summaries(Option<Vec::<TargetDomainSummary>>):

    The list of target domain summaries.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• On failure, responds with SdkError<ListTargetDomainsError>

impl Client

pub fn start_code_remediation(&self) -> StartCodeRemediationFluentBuilder

Constructs a fluent builder for the StartCodeRemediation operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • pentest_job_id(impl Into<String>) / set_pentest_job_id(Option<String>):
    required: false
    

    The unique identifier of the pentest job that produced the findings. Mutually exclusive with codeReviewJobId.

    
    
  • code_review_job_id(impl Into<String>) / set_code_review_job_id(Option<String>):
    required: false
    

    The unique identifier of the code review job that produced the findings. Mutually exclusive with pentestJobId.

    
    
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The list of finding identifiers to initiate code remediation for.

    
    
• On success, responds with StartCodeRemediationOutput
• On failure, responds with SdkError<StartCodeRemediationError>

impl Client

pub fn start_code_review_job(&self) -> StartCodeReviewJobFluentBuilder

Constructs a fluent builder for the StartCodeReviewJob operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • code_review_id(impl Into<String>) / set_code_review_id(Option<String>):
    required: true
    

    The unique identifier of the code review to start a job for.

    
    
• On success, responds with StartCodeReviewJobOutput with field(s):
  • title(Option<String>):

    The title of the code review job.

  • status(Option<JobStatus>):

    The current status of the code review job.

  • created_at(Option<DateTime>):

    The date and time the code review job was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the code review job was last updated, in UTC format.

  • code_review_id(String):

    The unique identifier of the code review.

  • code_review_job_id(String):

    The unique identifier of the started code review job.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space.

• On failure, responds with SdkError<StartCodeReviewJobError>

impl Client

pub fn start_pentest_job(&self) -> StartPentestJobFluentBuilder

Constructs a fluent builder for the StartPentestJob operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • pentest_id(impl Into<String>) / set_pentest_id(Option<String>):
    required: true
    

    The unique identifier of the pentest to start a job for.

    
    
• On success, responds with StartPentestJobOutput with field(s):
  • title(Option<String>):

    The title of the pentest job.

  • status(Option<JobStatus>):

    The current status of the pentest job.

  • created_at(Option<DateTime>):

    The date and time the pentest job was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the pentest job was last updated, in UTC format.

  • pentest_id(Option<String>):

    The unique identifier of the pentest.

  • pentest_job_id(Option<String>):

    The unique identifier of the started pentest job.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space.

• On failure, responds with SdkError<StartPentestJobError>

impl Client

pub fn stop_code_review_job(&self) -> StopCodeReviewJobFluentBuilder

Constructs a fluent builder for the StopCodeReviewJob operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • code_review_job_id(impl Into<String>) / set_code_review_job_id(Option<String>):
    required: true
    

    The unique identifier of the code review job to stop.

    
    
• On success, responds with StopCodeReviewJobOutput
• On failure, responds with SdkError<StopCodeReviewJobError>

impl Client

pub fn stop_pentest_job(&self) -> StopPentestJobFluentBuilder

Constructs a fluent builder for the StopPentestJob operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • pentest_job_id(impl Into<String>) / set_pentest_job_id(Option<String>):
    required: true
    

    The unique identifier of the pentest job to stop.

    
    
• On success, responds with StopPentestJobOutput
• On failure, responds with SdkError<StopPentestJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent_space(&self) -> UpdateAgentSpaceFluentBuilder

Constructs a fluent builder for the UpdateAgentSpace operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The updated name of the agent space.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the agent space.

    
    
  • aws_resources(AwsResources) / set_aws_resources(Option<AwsResources>):
    required: false
    

    The updated AWS resources to associate with the agent space.

    
    
  • target_domain_ids(impl Into<String>) / set_target_domain_ids(Option<Vec::<String>>):
    required: false
    

    The updated list of target domain identifiers to associate with the agent space.

    
    
  • code_review_settings(CodeReviewSettings) / set_code_review_settings(Option<CodeReviewSettings>):
    required: false
    

    The updated code review settings for the agent space.

    
    
• On success, responds with UpdateAgentSpaceOutput with field(s):
  • agent_space_id(String):

    The unique identifier of the updated agent space.

  • name(String):

    The name of the agent space.

  • description(Option<String>):

    The description of the agent space.

  • aws_resources(Option<AwsResources>):

    The AWS resources associated with the agent space.

  • target_domain_ids(Option<Vec::<String>>):

    The list of target domain identifiers associated with the agent space.

  • code_review_settings(Option<CodeReviewSettings>):

    The code review settings for the agent space.

  • created_at(Option<DateTime>):

    The date and time the agent space was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the agent space was last updated, in UTC format.

• On failure, responds with SdkError<UpdateAgentSpaceError>

impl Client

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application to update.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The updated Amazon Resource Name (ARN) of the IAM role for the application.

    
    
  • default_kms_key_id(impl Into<String>) / set_default_kms_key_id(Option<String>):
    required: false
    

    The updated identifier of the default AWS KMS key for the application.

    
    
• On success, responds with UpdateApplicationOutput with field(s):
  • application_id(String):

    The unique identifier of the updated application.

• On failure, responds with SdkError<UpdateApplicationError>

impl Client

pub fn update_code_review(&self) -> UpdateCodeReviewFluentBuilder

Constructs a fluent builder for the UpdateCodeReview operation.

• The fluent builder is configurable:
  • code_review_id(impl Into<String>) / set_code_review_id(Option<String>):
    required: true
    

    The unique identifier of the code review to update.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the code review.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    The updated title of the code review.

    
    
  • assets(Assets) / set_assets(Option<Assets>):
    required: false
    

    The updated assets for the code review.

    
    
  • service_role(impl Into<String>) / set_service_role(Option<String>):
    required: false
    

    The updated IAM service role for the code review.

    
    
  • log_config(CloudWatchLog) / set_log_config(Option<CloudWatchLog>):
    required: false
    

    The updated CloudWatch Logs configuration for the code review.

    
    
  • code_remediation_strategy(CodeRemediationStrategy) / set_code_remediation_strategy(Option<CodeRemediationStrategy>):
    required: false
    

    The updated code remediation strategy for the code review.

    
    
• On success, responds with UpdateCodeReviewOutput with field(s):
  • code_review_id(String):

    The unique identifier of the code review.

  • title(Option<String>):

    The title of the code review.

  • created_at(Option<DateTime>):

    The date and time the code review was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the code review was last updated, in UTC format.

  • assets(Option<Assets>):

    The assets included in the code review.

  • service_role(Option<String>):

    The IAM service role used for the code review.

  • log_config(Option<CloudWatchLog>):

    The CloudWatch Logs configuration for the code review.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space that contains the code review.

  • code_remediation_strategy(Option<CodeRemediationStrategy>):

    The code remediation strategy for the code review.

• On failure, responds with SdkError<UpdateCodeReviewError>

impl Client

pub fn update_finding(&self) -> UpdateFindingFluentBuilder

Constructs a fluent builder for the UpdateFinding operation.

• The fluent builder is configurable:
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    The unique identifier of the finding to update.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the finding.

    
    
  • risk_level(RiskLevel) / set_risk_level(Option<RiskLevel>):
    required: false
    

    The updated risk level for the finding.

    
    
  • status(FindingStatus) / set_status(Option<FindingStatus>):
    required: false
    

    The updated status for the finding.

    
    
• On success, responds with UpdateFindingOutput
• On failure, responds with SdkError<UpdateFindingError>

impl Client

pub fn update_integrated_resources( &self, ) -> UpdateIntegratedResourcesFluentBuilder

Constructs a fluent builder for the UpdateIntegratedResources operation.

• The fluent builder is configurable:
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space.

    
    
  • integration_id(impl Into<String>) / set_integration_id(Option<String>):
    required: true
    

    The unique identifier of the integration.

    
    
  • items(IntegratedResourceInputItem) / set_items(Option<Vec::<IntegratedResourceInputItem>>):
    required: true
    

    The list of integrated resource items to update.

    
    
• On success, responds with UpdateIntegratedResourcesOutput
• On failure, responds with SdkError<UpdateIntegratedResourcesError>

impl Client

pub fn update_pentest(&self) -> UpdatePentestFluentBuilder

Constructs a fluent builder for the UpdatePentest operation.

• The fluent builder is configurable:
  • pentest_id(impl Into<String>) / set_pentest_id(Option<String>):
    required: true
    

    The unique identifier of the pentest to update.

    
    
  • agent_space_id(impl Into<String>) / set_agent_space_id(Option<String>):
    required: true
    

    The unique identifier of the agent space that contains the pentest.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    The updated title of the pentest.

    
    
  • assets(Assets) / set_assets(Option<Assets>):
    required: false
    

    The updated assets for the pentest.

    
    
  • exclude_risk_types(RiskType) / set_exclude_risk_types(Option<Vec::<RiskType>>):
    required: false
    

    The updated list of risk types to exclude from the pentest.

    
    
  • service_role(impl Into<String>) / set_service_role(Option<String>):
    required: false
    

    The updated IAM service role for the pentest.

    
    
  • log_config(CloudWatchLog) / set_log_config(Option<CloudWatchLog>):
    required: false
    

    The updated CloudWatch Logs configuration for the pentest.

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

    The updated VPC configuration for the pentest.

    
    
  • network_traffic_config(NetworkTrafficConfig) / set_network_traffic_config(Option<NetworkTrafficConfig>):
    required: false
    

    The updated network traffic configuration for the pentest.

    
    
  • code_remediation_strategy(CodeRemediationStrategy) / set_code_remediation_strategy(Option<CodeRemediationStrategy>):
    required: false
    

    The updated code remediation strategy for the pentest.

    
    
• On success, responds with UpdatePentestOutput with field(s):
  • pentest_id(Option<String>):

    The unique identifier of the pentest.

  • title(Option<String>):

    The title of the pentest.

  • created_at(Option<DateTime>):

    The date and time the pentest was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the pentest was last updated, in UTC format.

  • assets(Option<Assets>):

    The assets included in the pentest.

  • exclude_risk_types(Option<Vec::<RiskType>>):

    The list of risk types excluded from the pentest.

  • service_role(Option<String>):

    The IAM service role used for the pentest.

  • log_config(Option<CloudWatchLog>):

    The CloudWatch Logs configuration for the pentest.

  • agent_space_id(Option<String>):

    The unique identifier of the agent space that contains the pentest.

• On failure, responds with SdkError<UpdatePentestError>

impl Client

pub fn update_target_domain(&self) -> UpdateTargetDomainFluentBuilder

Constructs a fluent builder for the UpdateTargetDomain operation.

• The fluent builder is configurable:
  • target_domain_id(impl Into<String>) / set_target_domain_id(Option<String>):
    required: true
    

    The unique identifier of the target domain to update.

    
    
  • verification_method(DomainVerificationMethod) / set_verification_method(Option<DomainVerificationMethod>):
    required: true
    

    The updated verification method for the target domain.

    
    
• On success, responds with UpdateTargetDomainOutput with field(s):
  • target_domain_id(String):

    The unique identifier of the target domain.

  • domain_name(String):

    The domain name of the target domain.

  • verification_status(TargetDomainStatus):

    The current verification status of the target domain.

  • verification_status_reason(Option<String>):

    The reason for the current target domain verification status.

  • verification_details(Option<VerificationDetails>):

    The updated verification details for the target domain.

  • created_at(Option<DateTime>):

    The date and time the target domain was created, in UTC format.

  • verified_at(Option<DateTime>):

    The date and time the target domain was verified, in UTC format.

• On failure, responds with SdkError<UpdateTargetDomainError>

impl Client

pub fn verify_target_domain(&self) -> VerifyTargetDomainFluentBuilder

Constructs a fluent builder for the VerifyTargetDomain operation.

• The fluent builder is configurable:
  • target_domain_id(impl Into<String>) / set_target_domain_id(Option<String>):
    required: true
    

    The unique identifier of the target domain to verify.

    
    
• On success, responds with VerifyTargetDomainOutput with field(s):
  • target_domain_id(Option<String>):

    The unique identifier of the target domain.

  • domain_name(Option<String>):

    The domain name of the target domain.

  • created_at(Option<DateTime>):

    The date and time the target domain was created, in UTC format.

  • updated_at(Option<DateTime>):

    The date and time the target domain was last updated, in UTC format.

  • verified_at(Option<DateTime>):

    The date and time the target domain was verified, in UTC format.

  • status(Option<TargetDomainStatus>):

    The verification status of the target domain.

  • verification_status_reason(Option<String>):

    The reason for the current target domain verification status.

• On failure, responds with SdkError<VerifyTargetDomainError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.