SecurityAgentClient

Index > SecurityAgent > SecurityAgentClient

Auto-generated documentation for SecurityAgent type annotations stubs module types-boto3-securityagent.

SecurityAgentClient

Type annotations and code completion for boto3.client("securityagent"). boto3 documentation

# SecurityAgentClient usage example

from boto3.session import Session
from types_boto3_securityagent.client import SecurityAgentClient

def get_securityagent_client() -> SecurityAgentClient:
    return Session().client("securityagent")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("securityagent").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("securityagent")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_securityagent.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("securityagent").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("securityagent").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_artifact

Adds an Artifact for the given agent space.

Type annotations and code completion for boto3.client("securityagent").add_artifact method. boto3 documentation

# add_artifact method definition

def add_artifact(
    self,
    *,
    agentSpaceId: str,
    artifactContent: BlobTypeDef,
    artifactType: ArtifactTypeType,  # (1)
    fileName: str,
) -> AddArtifactOutputTypeDef:  # (2)
    ...

1. See ArtifactTypeType
2. See AddArtifactOutputTypeDef

# add_artifact method usage example with argument unpacking

kwargs: AddArtifactInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "artifactContent": ...,
    "artifactType": ...,
    "fileName": ...,
}

parent.add_artifact(**kwargs)

1. See AddArtifactInputTypeDef

batch_delete_pentests

Deletes multiple pentests in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_delete_pentests method. boto3 documentation

# batch_delete_pentests method definition

def batch_delete_pentests(
    self,
    *,
    pentestIds: Sequence[str],
    agentSpaceId: str,
) -> BatchDeletePentestsOutputTypeDef:  # (1)
    ...

1. See BatchDeletePentestsOutputTypeDef

# batch_delete_pentests method usage example with argument unpacking

kwargs: BatchDeletePentestsInputTypeDef = {  # (1)
    "pentestIds": ...,
    "agentSpaceId": ...,
}

parent.batch_delete_pentests(**kwargs)

1. See BatchDeletePentestsInputTypeDef

batch_get_agent_spaces

Retrieves multiple agent spaces in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_agent_spaces method. boto3 documentation

# batch_get_agent_spaces method definition

def batch_get_agent_spaces(
    self,
    *,
    agentSpaceIds: Sequence[str],
) -> BatchGetAgentSpacesOutputTypeDef:  # (1)
    ...

1. See BatchGetAgentSpacesOutputTypeDef

# batch_get_agent_spaces method usage example with argument unpacking

kwargs: BatchGetAgentSpacesInputTypeDef = {  # (1)
    "agentSpaceIds": ...,
}

parent.batch_get_agent_spaces(**kwargs)

1. See BatchGetAgentSpacesInputTypeDef

batch_get_artifact_metadata

Retrieve the list of artifact metadata for the given agent space.

Type annotations and code completion for boto3.client("securityagent").batch_get_artifact_metadata method. boto3 documentation

# batch_get_artifact_metadata method definition

def batch_get_artifact_metadata(
    self,
    *,
    agentSpaceId: str,
    artifactIds: Sequence[str],
) -> BatchGetArtifactMetadataOutputTypeDef:  # (1)
    ...

1. See BatchGetArtifactMetadataOutputTypeDef

# batch_get_artifact_metadata method usage example with argument unpacking

kwargs: BatchGetArtifactMetadataInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "artifactIds": ...,
}

parent.batch_get_artifact_metadata(**kwargs)

1. See BatchGetArtifactMetadataInputTypeDef

batch_get_findings

Retrieves multiple findings in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_findings method. boto3 documentation

# batch_get_findings method definition

def batch_get_findings(
    self,
    *,
    findingIds: Sequence[str],
    agentSpaceId: str,
) -> BatchGetFindingsOutputTypeDef:  # (1)
    ...

1. See BatchGetFindingsOutputTypeDef

# batch_get_findings method usage example with argument unpacking

kwargs: BatchGetFindingsInputTypeDef = {  # (1)
    "findingIds": ...,
    "agentSpaceId": ...,
}

parent.batch_get_findings(**kwargs)

1. See BatchGetFindingsInputTypeDef

batch_get_pentest_job_tasks

Retrieves multiple tasks for a pentest job in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_pentest_job_tasks method. boto3 documentation

# batch_get_pentest_job_tasks method definition

def batch_get_pentest_job_tasks(
    self,
    *,
    agentSpaceId: str,
    taskIds: Sequence[str],
) -> BatchGetPentestJobTasksOutputTypeDef:  # (1)
    ...

1. See BatchGetPentestJobTasksOutputTypeDef

# batch_get_pentest_job_tasks method usage example with argument unpacking

kwargs: BatchGetPentestJobTasksInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskIds": ...,
}

parent.batch_get_pentest_job_tasks(**kwargs)

1. See BatchGetPentestJobTasksInputTypeDef

batch_get_pentest_jobs

Retrieves multiple pentest jobs in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_pentest_jobs method. boto3 documentation

# batch_get_pentest_jobs method definition

def batch_get_pentest_jobs(
    self,
    *,
    pentestJobIds: Sequence[str],
    agentSpaceId: str,
) -> BatchGetPentestJobsOutputTypeDef:  # (1)
    ...

1. See BatchGetPentestJobsOutputTypeDef

# batch_get_pentest_jobs method usage example with argument unpacking

kwargs: BatchGetPentestJobsInputTypeDef = {  # (1)
    "pentestJobIds": ...,
    "agentSpaceId": ...,
}

parent.batch_get_pentest_jobs(**kwargs)

1. See BatchGetPentestJobsInputTypeDef

batch_get_pentests

Retrieves multiple pentests in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_pentests method. boto3 documentation

# batch_get_pentests method definition

def batch_get_pentests(
    self,
    *,
    pentestIds: Sequence[str],
    agentSpaceId: str,
) -> BatchGetPentestsOutputTypeDef:  # (1)
    ...

1. See BatchGetPentestsOutputTypeDef

# batch_get_pentests method usage example with argument unpacking

kwargs: BatchGetPentestsInputTypeDef = {  # (1)
    "pentestIds": ...,
    "agentSpaceId": ...,
}

parent.batch_get_pentests(**kwargs)

1. See BatchGetPentestsInputTypeDef

batch_get_target_domains

Retrieves multiple target domains in a single request.

Type annotations and code completion for boto3.client("securityagent").batch_get_target_domains method. boto3 documentation

# batch_get_target_domains method definition

def batch_get_target_domains(
    self,
    *,
    targetDomainIds: Sequence[str],
) -> BatchGetTargetDomainsOutputTypeDef:  # (1)
    ...

1. See BatchGetTargetDomainsOutputTypeDef

# batch_get_target_domains method usage example with argument unpacking

kwargs: BatchGetTargetDomainsInputTypeDef = {  # (1)
    "targetDomainIds": ...,
}

parent.batch_get_target_domains(**kwargs)

1. See BatchGetTargetDomainsInputTypeDef

create_agent_space

Creates an agent space record.

Type annotations and code completion for boto3.client("securityagent").create_agent_space method. boto3 documentation

# create_agent_space method definition

def create_agent_space(
    self,
    *,
    name: str,
    description: str = ...,
    awsResources: AWSResourcesUnionTypeDef = ...,  # (1)
    targetDomainIds: Sequence[str] = ...,
    codeReviewSettings: CodeReviewSettingsTypeDef = ...,  # (2)
    kmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAgentSpaceOutputTypeDef:  # (3)
    ...

1. See AWSResourcesUnionTypeDef
2. See CodeReviewSettingsTypeDef
3. See CreateAgentSpaceOutputTypeDef

# create_agent_space method usage example with argument unpacking

kwargs: CreateAgentSpaceInputTypeDef = {  # (1)
    "name": ...,
}

parent.create_agent_space(**kwargs)

1. See CreateAgentSpaceInputTypeDef

create_application

Creates a new application.

Type annotations and code completion for boto3.client("securityagent").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    idcInstanceArn: str = ...,
    roleArn: str = ...,
    defaultKmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef:  # (1)
    ...

1. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestTypeDef = {  # (1)
    "idcInstanceArn": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationRequestTypeDef

create_integration

Creates the Integration of the Security Agent App with an external Provider.

Type annotations and code completion for boto3.client("securityagent").create_integration method. boto3 documentation

# create_integration method definition

def create_integration(
    self,
    *,
    provider: ProviderType,  # (1)
    input: ProviderInputTypeDef,  # (2)
    integrationDisplayName: str,
    kmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateIntegrationOutputTypeDef:  # (3)
    ...

1. See ProviderType
2. See ProviderInputTypeDef
3. See CreateIntegrationOutputTypeDef

# create_integration method usage example with argument unpacking

kwargs: CreateIntegrationInputTypeDef = {  # (1)
    "provider": ...,
    "input": ...,
    "integrationDisplayName": ...,
}

parent.create_integration(**kwargs)

1. See CreateIntegrationInputTypeDef

create_membership

Adds a single member to an agent space with specified role.

Type annotations and code completion for boto3.client("securityagent").create_membership method. boto3 documentation

# create_membership method definition

def create_membership(
    self,
    *,
    applicationId: str,
    agentSpaceId: str,
    membershipId: str,
    memberType: MembershipTypeType,  # (1)
    config: MembershipConfigTypeDef = ...,  # (2)
) -> dict[str, Any]:
    ...

1. See MembershipTypeType
2. See MembershipConfigTypeDef

# create_membership method usage example with argument unpacking

kwargs: CreateMembershipRequestTypeDef = {  # (1)
    "applicationId": ...,
    "agentSpaceId": ...,
    "membershipId": ...,
    "memberType": ...,
}

parent.create_membership(**kwargs)

1. See CreateMembershipRequestTypeDef

create_pentest

Creates a new pentest configuration.

Type annotations and code completion for boto3.client("securityagent").create_pentest method. boto3 documentation

# create_pentest method definition

def create_pentest(
    self,
    *,
    title: str,
    agentSpaceId: str,
    assets: AssetsUnionTypeDef = ...,  # (1)
    excludeRiskTypes: Sequence[RiskTypeType] = ...,  # (2)
    serviceRole: str = ...,
    logConfig: CloudWatchLogTypeDef = ...,  # (3)
    vpcConfig: VpcConfigUnionTypeDef = ...,  # (4)
    networkTrafficConfig: NetworkTrafficConfigUnionTypeDef = ...,  # (5)
    codeRemediationStrategy: CodeRemediationStrategyType = ...,  # (6)
) -> CreatePentestOutputTypeDef:  # (7)
    ...

1. See AssetsUnionTypeDef
2. See Sequence[RiskTypeType]
3. See CloudWatchLogTypeDef
4. See VpcConfigUnionTypeDef
5. See NetworkTrafficConfigUnionTypeDef
6. See CodeRemediationStrategyType
7. See CreatePentestOutputTypeDef

# create_pentest method usage example with argument unpacking

kwargs: CreatePentestInputTypeDef = {  # (1)
    "title": ...,
    "agentSpaceId": ...,
}

parent.create_pentest(**kwargs)

1. See CreatePentestInputTypeDef

create_target_domain

Creates a target domain record.

Type annotations and code completion for boto3.client("securityagent").create_target_domain method. boto3 documentation

# create_target_domain method definition

def create_target_domain(
    self,
    *,
    targetDomainName: str,
    verificationMethod: DomainVerificationMethodType,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateTargetDomainOutputTypeDef:  # (2)
    ...

1. See DomainVerificationMethodType
2. See CreateTargetDomainOutputTypeDef

# create_target_domain method usage example with argument unpacking

kwargs: CreateTargetDomainInputTypeDef = {  # (1)
    "targetDomainName": ...,
    "verificationMethod": ...,
}

parent.create_target_domain(**kwargs)

1. See CreateTargetDomainInputTypeDef

delete_agent_space

Deletes an agent space record.

Type annotations and code completion for boto3.client("securityagent").delete_agent_space method. boto3 documentation

# delete_agent_space method definition

def delete_agent_space(
    self,
    *,
    agentSpaceId: str,
) -> DeleteAgentSpaceOutputTypeDef:  # (1)
    ...

1. See DeleteAgentSpaceOutputTypeDef

# delete_agent_space method usage example with argument unpacking

kwargs: DeleteAgentSpaceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.delete_agent_space(**kwargs)

1. See DeleteAgentSpaceInputTypeDef

delete_application

Deletes an application.

Type annotations and code completion for boto3.client("securityagent").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    applicationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)

1. See DeleteApplicationRequestTypeDef

delete_artifact

Delete an Artifact from the given agent space.

Type annotations and code completion for boto3.client("securityagent").delete_artifact method. boto3 documentation

# delete_artifact method definition

def delete_artifact(
    self,
    *,
    agentSpaceId: str,
    artifactId: str,
) -> dict[str, Any]:
    ...

# delete_artifact method usage example with argument unpacking

kwargs: DeleteArtifactInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "artifactId": ...,
}

parent.delete_artifact(**kwargs)

1. See DeleteArtifactInputTypeDef

delete_integration

Deletes the Integration of the Security Agent App with an external Provider.

Type annotations and code completion for boto3.client("securityagent").delete_integration method. boto3 documentation

# delete_integration method definition

def delete_integration(
    self,
    *,
    integrationId: str,
) -> dict[str, Any]:
    ...

# delete_integration method usage example with argument unpacking

kwargs: DeleteIntegrationInputTypeDef = {  # (1)
    "integrationId": ...,
}

parent.delete_integration(**kwargs)

1. See DeleteIntegrationInputTypeDef

delete_membership

Removes a single member associated to an agent space.

Type annotations and code completion for boto3.client("securityagent").delete_membership method. boto3 documentation

# delete_membership method definition

def delete_membership(
    self,
    *,
    applicationId: str,
    agentSpaceId: str,
    membershipId: str,
    memberType: MembershipTypeType = ...,  # (1)
) -> dict[str, Any]:
    ...

1. See MembershipTypeType

# delete_membership method usage example with argument unpacking

kwargs: DeleteMembershipRequestTypeDef = {  # (1)
    "applicationId": ...,
    "agentSpaceId": ...,
    "membershipId": ...,
}

parent.delete_membership(**kwargs)

1. See DeleteMembershipRequestTypeDef

delete_target_domain

Deletes a target domain record.

Type annotations and code completion for boto3.client("securityagent").delete_target_domain method. boto3 documentation

# delete_target_domain method definition

def delete_target_domain(
    self,
    *,
    targetDomainId: str,
) -> DeleteTargetDomainOutputTypeDef:  # (1)
    ...

1. See DeleteTargetDomainOutputTypeDef

# delete_target_domain method usage example with argument unpacking

kwargs: DeleteTargetDomainInputTypeDef = {  # (1)
    "targetDomainId": ...,
}

parent.delete_target_domain(**kwargs)

1. See DeleteTargetDomainInputTypeDef

get_application

Retrieves application details by application ID.

Type annotations and code completion for boto3.client("securityagent").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    applicationId: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...

1. See GetApplicationResponseTypeDef

# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationRequestTypeDef

get_artifact

Retrieve an Artifact for the given agent space.

Type annotations and code completion for boto3.client("securityagent").get_artifact method. boto3 documentation

# get_artifact method definition

def get_artifact(
    self,
    *,
    agentSpaceId: str,
    artifactId: str,
) -> GetArtifactOutputTypeDef:  # (1)
    ...

1. See GetArtifactOutputTypeDef

# get_artifact method usage example with argument unpacking

kwargs: GetArtifactInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "artifactId": ...,
}

parent.get_artifact(**kwargs)

1. See GetArtifactInputTypeDef

get_integration

Gets Integration metadata from the provided id.

Type annotations and code completion for boto3.client("securityagent").get_integration method. boto3 documentation

# get_integration method definition

def get_integration(
    self,
    *,
    integrationId: str,
) -> GetIntegrationOutputTypeDef:  # (1)
    ...

1. See GetIntegrationOutputTypeDef

# get_integration method usage example with argument unpacking

kwargs: GetIntegrationInputTypeDef = {  # (1)
    "integrationId": ...,
}

parent.get_integration(**kwargs)

1. See GetIntegrationInputTypeDef

initiate_provider_registration

Initiates the registration of Security Agent App for an external Provider.

Type annotations and code completion for boto3.client("securityagent").initiate_provider_registration method. boto3 documentation

# initiate_provider_registration method definition

def initiate_provider_registration(
    self,
    *,
    provider: ProviderType,  # (1)
) -> InitiateProviderRegistrationOutputTypeDef:  # (2)
    ...

1. See ProviderType
2. See InitiateProviderRegistrationOutputTypeDef

# initiate_provider_registration method usage example with argument unpacking

kwargs: InitiateProviderRegistrationInputTypeDef = {  # (1)
    "provider": ...,
}

parent.initiate_provider_registration(**kwargs)

1. See InitiateProviderRegistrationInputTypeDef

list_agent_spaces

Lists agent spaces.

Type annotations and code completion for boto3.client("securityagent").list_agent_spaces method. boto3 documentation

# list_agent_spaces method definition

def list_agent_spaces(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAgentSpacesOutputTypeDef:  # (1)
    ...

1. See ListAgentSpacesOutputTypeDef

# list_agent_spaces method usage example with argument unpacking

kwargs: ListAgentSpacesInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_agent_spaces(**kwargs)

1. See ListAgentSpacesInputTypeDef

list_applications

Lists all applications in the account.

Type annotations and code completion for boto3.client("securityagent").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationsResponseTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsRequestTypeDef

list_artifacts

Lists the artifacts for the associated agent space.

Type annotations and code completion for boto3.client("securityagent").list_artifacts method. boto3 documentation

# list_artifacts method definition

def list_artifacts(
    self,
    *,
    agentSpaceId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListArtifactsOutputTypeDef:  # (1)
    ...

1. See ListArtifactsOutputTypeDef

# list_artifacts method usage example with argument unpacking

kwargs: ListArtifactsInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_artifacts(**kwargs)

1. See ListArtifactsInputTypeDef

list_discovered_endpoints

Lists discovered endpoints associated with a pentest job with optional URI prefix filtering.

Type annotations and code completion for boto3.client("securityagent").list_discovered_endpoints method. boto3 documentation

# list_discovered_endpoints method definition

def list_discovered_endpoints(
    self,
    *,
    pentestJobId: str,
    agentSpaceId: str,
    maxResults: int = ...,
    prefix: str = ...,
    nextToken: str = ...,
) -> ListDiscoveredEndpointsOutputTypeDef:  # (1)
    ...

1. See ListDiscoveredEndpointsOutputTypeDef

# list_discovered_endpoints method usage example with argument unpacking

kwargs: ListDiscoveredEndpointsInputTypeDef = {  # (1)
    "pentestJobId": ...,
    "agentSpaceId": ...,
}

parent.list_discovered_endpoints(**kwargs)

1. See ListDiscoveredEndpointsInputTypeDef

list_findings

Lists findings with filtering and pagination support.

Type annotations and code completion for boto3.client("securityagent").list_findings method. boto3 documentation

# list_findings method definition

def list_findings(
    self,
    *,
    pentestJobId: str,
    agentSpaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    riskType: str = ...,
    riskLevel: RiskLevelType = ...,  # (1)
    status: FindingStatusType = ...,  # (2)
    confidence: ConfidenceLevelType = ...,  # (3)
    name: str = ...,
) -> ListFindingsOutputTypeDef:  # (4)
    ...

1. See RiskLevelType
2. See FindingStatusType
3. See ConfidenceLevelType
4. See ListFindingsOutputTypeDef

# list_findings method usage example with argument unpacking

kwargs: ListFindingsInputTypeDef = {  # (1)
    "pentestJobId": ...,
    "agentSpaceId": ...,
}

parent.list_findings(**kwargs)

1. See ListFindingsInputTypeDef

list_integrated_resources

Lists the integrated resources for an agent space.

Type annotations and code completion for boto3.client("securityagent").list_integrated_resources method. boto3 documentation

# list_integrated_resources method definition

def list_integrated_resources(
    self,
    *,
    agentSpaceId: str,
    integrationId: str = ...,
    resourceType: ResourceTypeType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIntegratedResourcesOutputTypeDef:  # (2)
    ...

1. See ResourceTypeType
2. See ListIntegratedResourcesOutputTypeDef

# list_integrated_resources method usage example with argument unpacking

kwargs: ListIntegratedResourcesInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_integrated_resources(**kwargs)

1. See ListIntegratedResourcesInputTypeDef

list_integrations

Retrieves the Integrations associated with the user's account.

Type annotations and code completion for boto3.client("securityagent").list_integrations method. boto3 documentation

# list_integrations method definition

def list_integrations(
    self,
    *,
    filter: IntegrationFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIntegrationsOutputTypeDef:  # (2)
    ...

1. See IntegrationFilterTypeDef
2. See ListIntegrationsOutputTypeDef

# list_integrations method usage example with argument unpacking

kwargs: ListIntegrationsInputTypeDef = {  # (1)
    "filter": ...,
}

parent.list_integrations(**kwargs)

1. See ListIntegrationsInputTypeDef

list_memberships

Lists all members associated to an agent space with pagination support.

Type annotations and code completion for boto3.client("securityagent").list_memberships method. boto3 documentation

# list_memberships method definition

def list_memberships(
    self,
    *,
    applicationId: str,
    agentSpaceId: str,
    memberType: MembershipTypeFilterType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMembershipsResponseTypeDef:  # (2)
    ...

1. See MembershipTypeFilterType
2. See ListMembershipsResponseTypeDef

# list_memberships method usage example with argument unpacking

kwargs: ListMembershipsRequestTypeDef = {  # (1)
    "applicationId": ...,
    "agentSpaceId": ...,
}

parent.list_memberships(**kwargs)

1. See ListMembershipsRequestTypeDef

list_pentest_job_tasks

Lists tasks associated with a specific pentest job.

Type annotations and code completion for boto3.client("securityagent").list_pentest_job_tasks method. boto3 documentation

# list_pentest_job_tasks method definition

def list_pentest_job_tasks(
    self,
    *,
    agentSpaceId: str,
    maxResults: int = ...,
    pentestJobId: str = ...,
    stepName: StepNameType = ...,  # (1)
    categoryName: str = ...,
    nextToken: str = ...,
) -> ListPentestJobTasksOutputTypeDef:  # (2)
    ...

1. See StepNameType
2. See ListPentestJobTasksOutputTypeDef

# list_pentest_job_tasks method usage example with argument unpacking

kwargs: ListPentestJobTasksInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_pentest_job_tasks(**kwargs)

1. See ListPentestJobTasksInputTypeDef

list_pentest_jobs_for_pentest

Lists pentest jobs associated with a pentest.

Type annotations and code completion for boto3.client("securityagent").list_pentest_jobs_for_pentest method. boto3 documentation

# list_pentest_jobs_for_pentest method definition

def list_pentest_jobs_for_pentest(
    self,
    *,
    pentestId: str,
    agentSpaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPentestJobsForPentestOutputTypeDef:  # (1)
    ...

1. See ListPentestJobsForPentestOutputTypeDef

# list_pentest_jobs_for_pentest method usage example with argument unpacking

kwargs: ListPentestJobsForPentestInputTypeDef = {  # (1)
    "pentestId": ...,
    "agentSpaceId": ...,
}

parent.list_pentest_jobs_for_pentest(**kwargs)

1. See ListPentestJobsForPentestInputTypeDef

list_pentests

Lists pentests with optional filtering by status.

Type annotations and code completion for boto3.client("securityagent").list_pentests method. boto3 documentation

# list_pentests method definition

def list_pentests(
    self,
    *,
    agentSpaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPentestsOutputTypeDef:  # (1)
    ...

1. See ListPentestsOutputTypeDef

# list_pentests method usage example with argument unpacking

kwargs: ListPentestsInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_pentests(**kwargs)

1. See ListPentestsInputTypeDef

list_tags_for_resource

Lists tags for a Security Agent resource.

Type annotations and code completion for boto3.client("securityagent").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

list_target_domains

Lists target domains.

Type annotations and code completion for boto3.client("securityagent").list_target_domains method. boto3 documentation

# list_target_domains method definition

def list_target_domains(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTargetDomainsOutputTypeDef:  # (1)
    ...

1. See ListTargetDomainsOutputTypeDef

# list_target_domains method usage example with argument unpacking

kwargs: ListTargetDomainsInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_target_domains(**kwargs)

1. See ListTargetDomainsInputTypeDef

start_code_remediation

Starts code remediation for the specified findings.

Type annotations and code completion for boto3.client("securityagent").start_code_remediation method. boto3 documentation

# start_code_remediation method definition

def start_code_remediation(
    self,
    *,
    agentSpaceId: str,
    pentestJobId: str,
    findingIds: Sequence[str],
) -> dict[str, Any]:
    ...

# start_code_remediation method usage example with argument unpacking

kwargs: StartCodeRemediationInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "pentestJobId": ...,
    "findingIds": ...,
}

parent.start_code_remediation(**kwargs)

1. See StartCodeRemediationInputTypeDef

start_pentest_job

Initiates the execution of a pentest.

Type annotations and code completion for boto3.client("securityagent").start_pentest_job method. boto3 documentation

# start_pentest_job method definition

def start_pentest_job(
    self,
    *,
    agentSpaceId: str,
    pentestId: str,
) -> StartPentestJobOutputTypeDef:  # (1)
    ...

1. See StartPentestJobOutputTypeDef

# start_pentest_job method usage example with argument unpacking

kwargs: StartPentestJobInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "pentestId": ...,
}

parent.start_pentest_job(**kwargs)

1. See StartPentestJobInputTypeDef

stop_pentest_job

Stops the execution of a running pentest.

Type annotations and code completion for boto3.client("securityagent").stop_pentest_job method. boto3 documentation

# stop_pentest_job method definition

def stop_pentest_job(
    self,
    *,
    agentSpaceId: str,
    pentestJobId: str,
) -> dict[str, Any]:
    ...

# stop_pentest_job method usage example with argument unpacking

kwargs: StopPentestJobInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "pentestJobId": ...,
}

parent.stop_pentest_job(**kwargs)

1. See StopPentestJobInputTypeDef

tag_resource

Adds tags to a Security Agent resource.

Type annotations and code completion for boto3.client("securityagent").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputTypeDef

untag_resource

Removes tags from a Security Agent resource.

Type annotations and code completion for boto3.client("securityagent").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputTypeDef

update_agent_space

Updates an agent space record.

Type annotations and code completion for boto3.client("securityagent").update_agent_space method. boto3 documentation

# update_agent_space method definition

def update_agent_space(
    self,
    *,
    agentSpaceId: str,
    name: str = ...,
    description: str = ...,
    awsResources: AWSResourcesUnionTypeDef = ...,  # (1)
    targetDomainIds: Sequence[str] = ...,
    codeReviewSettings: CodeReviewSettingsTypeDef = ...,  # (2)
) -> UpdateAgentSpaceOutputTypeDef:  # (3)
    ...

1. See AWSResourcesUnionTypeDef
2. See CodeReviewSettingsTypeDef
3. See UpdateAgentSpaceOutputTypeDef

# update_agent_space method usage example with argument unpacking

kwargs: UpdateAgentSpaceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.update_agent_space(**kwargs)

1. See UpdateAgentSpaceInputTypeDef

update_application

Updates application configuration.

Type annotations and code completion for boto3.client("securityagent").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    applicationId: str,
    roleArn: str = ...,
    defaultKmsKeyId: str = ...,
) -> UpdateApplicationResponseTypeDef:  # (1)
    ...

1. See UpdateApplicationResponseTypeDef

# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationRequestTypeDef

update_finding

Updates an existing security finding with new details or status.

Type annotations and code completion for boto3.client("securityagent").update_finding method. boto3 documentation

# update_finding method definition

def update_finding(
    self,
    *,
    findingId: str,
    agentSpaceId: str,
    riskLevel: RiskLevelType = ...,  # (1)
    status: FindingStatusType = ...,  # (2)
) -> dict[str, Any]:
    ...

1. See RiskLevelType
2. See FindingStatusType

# update_finding method usage example with argument unpacking

kwargs: UpdateFindingInputTypeDef = {  # (1)
    "findingId": ...,
    "agentSpaceId": ...,
}

parent.update_finding(**kwargs)

1. See UpdateFindingInputTypeDef

update_integrated_resources

Updates the integrated resources for an agent space.

Type annotations and code completion for boto3.client("securityagent").update_integrated_resources method. boto3 documentation

# update_integrated_resources method definition

def update_integrated_resources(
    self,
    *,
    agentSpaceId: str,
    integrationId: str,
    items: Sequence[IntegratedResourceInputItemTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See Sequence[IntegratedResourceInputItemTypeDef]

# update_integrated_resources method usage example with argument unpacking

kwargs: UpdateIntegratedResourcesInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "integrationId": ...,
    "items": ...,
}

parent.update_integrated_resources(**kwargs)

1. See UpdateIntegratedResourcesInputTypeDef

update_pentest

Updates an existing pentest with new configuration or settings.

Type annotations and code completion for boto3.client("securityagent").update_pentest method. boto3 documentation

# update_pentest method definition

def update_pentest(
    self,
    *,
    pentestId: str,
    agentSpaceId: str,
    title: str = ...,
    assets: AssetsUnionTypeDef = ...,  # (1)
    excludeRiskTypes: Sequence[RiskTypeType] = ...,  # (2)
    serviceRole: str = ...,
    logConfig: CloudWatchLogTypeDef = ...,  # (3)
    vpcConfig: VpcConfigUnionTypeDef = ...,  # (4)
    networkTrafficConfig: NetworkTrafficConfigUnionTypeDef = ...,  # (5)
    codeRemediationStrategy: CodeRemediationStrategyType = ...,  # (6)
) -> UpdatePentestOutputTypeDef:  # (7)
    ...

1. See AssetsUnionTypeDef
2. See Sequence[RiskTypeType]
3. See CloudWatchLogTypeDef
4. See VpcConfigUnionTypeDef
5. See NetworkTrafficConfigUnionTypeDef
6. See CodeRemediationStrategyType
7. See UpdatePentestOutputTypeDef

# update_pentest method usage example with argument unpacking

kwargs: UpdatePentestInputTypeDef = {  # (1)
    "pentestId": ...,
    "agentSpaceId": ...,
}

parent.update_pentest(**kwargs)

1. See UpdatePentestInputTypeDef

update_target_domain

Updates a target domain record.

Type annotations and code completion for boto3.client("securityagent").update_target_domain method. boto3 documentation

# update_target_domain method definition

def update_target_domain(
    self,
    *,
    targetDomainId: str,
    verificationMethod: DomainVerificationMethodType,  # (1)
) -> UpdateTargetDomainOutputTypeDef:  # (2)
    ...

1. See DomainVerificationMethodType
2. See UpdateTargetDomainOutputTypeDef

# update_target_domain method usage example with argument unpacking

kwargs: UpdateTargetDomainInputTypeDef = {  # (1)
    "targetDomainId": ...,
    "verificationMethod": ...,
}

parent.update_target_domain(**kwargs)

1. See UpdateTargetDomainInputTypeDef

verify_target_domain

Verifies ownership for a registered target domain.

Type annotations and code completion for boto3.client("securityagent").verify_target_domain method. boto3 documentation

# verify_target_domain method definition

def verify_target_domain(
    self,
    *,
    targetDomainId: str,
) -> VerifyTargetDomainOutputTypeDef:  # (1)
    ...

1. See VerifyTargetDomainOutputTypeDef

# verify_target_domain method usage example with argument unpacking

kwargs: VerifyTargetDomainInputTypeDef = {  # (1)
    "targetDomainId": ...,
}

parent.verify_target_domain(**kwargs)

1. See VerifyTargetDomainInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("securityagent").get_paginator method with overloads.

• client.get_paginator("list_agent_spaces") -> ListAgentSpacesPaginator
• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_artifacts") -> ListArtifactsPaginator
• client.get_paginator("list_discovered_endpoints") -> ListDiscoveredEndpointsPaginator
• client.get_paginator("list_findings") -> ListFindingsPaginator
• client.get_paginator("list_integrated_resources") -> ListIntegratedResourcesPaginator
• client.get_paginator("list_integrations") -> ListIntegrationsPaginator
• client.get_paginator("list_memberships") -> ListMembershipsPaginator
• client.get_paginator("list_pentest_job_tasks") -> ListPentestJobTasksPaginator
• client.get_paginator("list_pentest_jobs_for_pentest") -> ListPentestJobsForPentestPaginator
• client.get_paginator("list_pentests") -> ListPentestsPaginator
• client.get_paginator("list_target_domains") -> ListTargetDomainsPaginator