SecurityAgent module#
Index > SecurityAgent
Auto-generated documentation for SecurityAgent type annotations stubs module mypy-boto3-securityagent.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3 package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.43.34' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
SecurityAgentservice. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and SecurityAgent.
From PyPI with pip#
Install boto3-stubs for SecurityAgent service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[securityagent]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[securityagent]'
# standalone installation
python -m pip install mypy-boto3-securityagent
How to uninstall#
python -m pip uninstall -y mypy-boto3-securityagent
Usage#
Code samples can be found in Examples.
SecurityAgentClient#
Type annotations and code completion for boto3.client("securityagent") as SecurityAgentClient
boto3 documentation
# SecurityAgentClient usage example
from boto3.session import Session
from mypy_boto3_securityagent.client import SecurityAgentClient
def get_client() -> SecurityAgentClient:
return Session().client("securityagent")
Paginators#
Type annotations and code completion for paginators
from boto3.client("securityagent").get_paginator("...").
# ListAgentSpacesPaginator usage example
from boto3.session import Session
from mypy_boto3_securityagent.paginator import ListAgentSpacesPaginator
def get_list_agent_spaces_paginator() -> ListAgentSpacesPaginator:
return Session().client("securityagent").get_paginator("list_agent_spaces"))
- ListAgentSpacesPaginator
- ListApplicationsPaginator
- ListArtifactsPaginator
- ListCodeReviewJobTasksPaginator
- ListCodeReviewJobsForCodeReviewPaginator
- ListCodeReviewsPaginator
- ListDiscoveredEndpointsPaginator
- ListFindingsPaginator
- ListIntegratedResourcesPaginator
- ListIntegrationsPaginator
- ListMembershipsPaginator
- ListPentestJobTasksPaginator
- ListPentestJobsForPentestPaginator
- ListPentestsPaginator
- ListPrivateConnectionsPaginator
- ListSecurityRequirementPacksPaginator
- ListSecurityRequirementsPaginator
- ListTargetDomainsPaginator
- ListThreatModelJobTasksPaginator
- ListThreatModelJobsPaginator
- ListThreatModelsPaginator
- ListThreatsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccessTypeType usage example
from mypy_boto3_securityagent.literals import AccessTypeType
def get_value() -> AccessTypeType:
return "PRIVATE"
- AccessTypeType
- ArtifactTypeType
- AuthenticationProviderTypeType
- CleanUpStrategyType
- CodeRemediationStrategyType
- CodeRemediationTaskStatusType
- ConfidenceLevelType
- ContextTypeType
- DNSRecordTypeType
- DomainVerificationMethodType
- ErrorCodeType
- FindingStatusType
- GitLabTokenTypeType
- IpAddressTypeType
- JobStatusType
- ListAgentSpacesPaginatorName
- ListApplicationsPaginatorName
- ListArtifactsPaginatorName
- ListCodeReviewJobTasksPaginatorName
- ListCodeReviewJobsForCodeReviewPaginatorName
- ListCodeReviewsPaginatorName
- ListDiscoveredEndpointsPaginatorName
- ListFindingsPaginatorName
- ListIntegratedResourcesPaginatorName
- ListIntegrationsPaginatorName
- ListMembershipsPaginatorName
- ListPentestJobTasksPaginatorName
- ListPentestJobsForPentestPaginatorName
- ListPentestsPaginatorName
- ListPrivateConnectionsPaginatorName
- ListSecurityRequirementPacksPaginatorName
- ListSecurityRequirementsPaginatorName
- ListTargetDomainsPaginatorName
- ListThreatModelJobTasksPaginatorName
- ListThreatModelJobsPaginatorName
- ListThreatModelsPaginatorName
- ListThreatsPaginatorName
- LogTypeType
- ManagementTypeType
- MembershipTypeFilterType
- MembershipTypeType
- NetworkTrafficRuleEffectType
- NetworkTrafficRuleTypeType
- PrivateConnectionStatusType
- PrivateConnectionTypeType
- ProviderType
- ProviderTypeType
- ResourceConfigDnsResolutionType
- ResourceTypeType
- RiskLevelType
- RiskTypeType
- SecurityRequirementArtifactFormatType
- SecurityRequirementPackImportStatusType
- SecurityRequirementPackStatusType
- SkillTypeType
- StepNameType
- StepStatusType
- StrideCategoryType
- TargetDomainStatusType
- TaskExecutionStatusType
- ThreatActorType
- ThreatSeverityType
- ThreatStatusType
- UserRoleType
- ValidationModeType
- ValidationStatusType
- SecurityAgentServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- VpcConfigOutputTypeDef
- VpcConfigTypeDef
- AuthenticationTypeDef
- BlobTypeDef
- ResponseMetadataTypeDef
- AgentSpaceSummaryTypeDef
- CodeReviewSettingsTypeDef
- ApplicationSummaryTypeDef
- ArtifactMetadataItemTypeDef
- ArtifactSummaryTypeDef
- ArtifactTypeDef
- EndpointTypeDef
- IntegratedRepositoryTypeDef
- SourceCodeRepositoryTypeDef
- BatchCreateSecurityRequirementResultTypeDef
- CreateSecurityRequirementEntryTypeDef
- BatchSecurityRequirementErrorTypeDef
- BatchDeleteCodeReviewsInputTypeDef
- DeleteCodeReviewFailureTypeDef
- BatchDeletePentestsInputTypeDef
- DeletePentestFailureTypeDef
- BatchDeleteSecurityRequirementsInputTypeDef
- BatchDeleteThreatModelsInputTypeDef
- DeleteThreatModelFailureTypeDef
- BatchGetAgentSpacesInputTypeDef
- BatchGetArtifactMetadataInputTypeDef
- BatchGetCodeReviewJobTasksInputTypeDef
- BatchGetCodeReviewJobsInputTypeDef
- BatchGetCodeReviewsInputTypeDef
- BatchGetFindingsInputTypeDef
- BatchGetPentestJobTasksInputTypeDef
- BatchGetPentestJobsInputTypeDef
- BatchGetPentestsInputTypeDef
- BatchGetSecurityRequirementResultTypeDef
- BatchGetSecurityRequirementsInputTypeDef
- BatchGetTargetDomainsInputTypeDef
- BatchGetThreatModelJobTasksInputTypeDef
- BatchGetThreatModelJobsInputTypeDef
- BatchGetThreatModelsInputTypeDef
- BatchGetThreatsInputTypeDef
- UpdateSecurityRequirementEntryTypeDef
- BitbucketIntegrationInputTypeDef
- BitbucketRepositoryMetadataTypeDef
- BitbucketRepositoryResourceTypeDef
- BitbucketResourceCapabilitiesTypeDef
- CategoryTypeDef
- CloudWatchLogTypeDef
- CodeLocationTypeDef
- CodeRemediationTaskDetailsTypeDef
- CodeReviewJobSummaryTypeDef
- CodeReviewJobTaskSummaryTypeDef
- ErrorInformationTypeDef
- ExecutionContextTypeDef
- StepTypeDef
- CodeReviewSummaryTypeDef
- ConfluenceDocumentMetadataTypeDef
- ConfluenceDocumentResourceTypeDef
- ConfluenceIntegrationInputTypeDef
- ConfluenceResourceCapabilitiesTypeDef
- CreateApplicationRequestTypeDef
- CreateSecurityRequirementPackInputTypeDef
- CreateTargetDomainInputTypeDef
- ThreatAnchorShapeTypeDef
- ThreatEvidenceShapeTypeDef
- ReportDestinationTypeDef
- CustomHeaderTypeDef
- DeleteAgentSpaceInputTypeDef
- DeleteApplicationRequestTypeDef
- DeleteArtifactInputTypeDef
- DeleteIntegrationInputTypeDef
- DeleteMembershipRequestTypeDef
- DeletePrivateConnectionInputTypeDef
- DeleteSecurityRequirementPackInputTypeDef
- DeleteTargetDomainInputTypeDef
- DescribePrivateConnectionInputTypeDef
- DiffSourceTypeDef
- DiscoveredEndpointTypeDef
- DnsVerificationTypeDef
- IntegratedDocumentTypeDef
- FindingSummaryTypeDef
- GetApplicationRequestTypeDef
- IdCConfigurationTypeDef
- GetArtifactInputTypeDef
- GetIntegrationInputTypeDef
- GetSecurityRequirementPackInputTypeDef
- GitHubIntegrationInputTypeDef
- GitHubRepositoryMetadataTypeDef
- GitHubRepositoryResourceTypeDef
- GitHubResourceCapabilitiesTypeDef
- GitLabIntegrationInputTypeDef
- GitLabRepositoryMetadataTypeDef
- GitLabRepositoryResourceTypeDef
- GitLabResourceCapabilitiesTypeDef
- HttpVerificationTypeDef
- InitiateProviderRegistrationInputTypeDef
- IntegrationFilterTypeDef
- IntegrationSummaryTypeDef
- PaginatorConfigTypeDef
- ListAgentSpacesInputTypeDef
- ListApplicationsRequestTypeDef
- ListArtifactsInputTypeDef
- ListCodeReviewJobTasksInputTypeDef
- ListCodeReviewJobsForCodeReviewInputTypeDef
- ListCodeReviewsInputTypeDef
- ListDiscoveredEndpointsInputTypeDef
- ListFindingsInputTypeDef
- ListIntegratedResourcesInputTypeDef
- ListMembershipsRequestTypeDef
- ListPentestJobTasksInputTypeDef
- TaskSummaryTypeDef
- ListPentestJobsForPentestInputTypeDef
- PentestJobSummaryTypeDef
- ListPentestsInputTypeDef
- PentestSummaryTypeDef
- ListPrivateConnectionsInputTypeDef
- PrivateConnectionSummaryTypeDef
- ListSecurityRequirementPackFilterTypeDef
- SecurityRequirementPackSummaryTypeDef
- ListSecurityRequirementsInputTypeDef
- SecurityRequirementSummaryTypeDef
- ListTagsForResourceInputTypeDef
- ListTargetDomainsInputTypeDef
- TargetDomainSummaryTypeDef
- ListThreatModelJobTasksInputTypeDef
- ThreatModelJobTaskSummaryTypeDef
- ListThreatModelJobsInputTypeDef
- ThreatModelJobSummaryTypeDef
- ListThreatModelsInputTypeDef
- ThreatModelSummaryTypeDef
- ListThreatsInputTypeDef
- ThreatSummaryTypeDef
- UserMetadataTypeDef
- UserConfigTypeDef
- NetworkTrafficRuleTypeDef
- SelfManagedInputTypeDef
- ServiceManagedInputTypeDef
- StartCodeRemediationInputTypeDef
- StartPentestJobInputTypeDef
- StartThreatModelJobInputTypeDef
- StopCodeReviewJobInputTypeDef
- StopPentestJobInputTypeDef
- StopThreatModelJobInputTypeDef
- TagResourceInputTypeDef
- UntagResourceInputTypeDef
- UpdateApplicationRequestTypeDef
- UpdateFindingInputTypeDef
- UpdatePrivateConnectionCertificateInputTypeDef
- UpdateSecurityRequirementPackInputTypeDef
- UpdateTargetDomainInputTypeDef
- VerificationScriptEnvVarTypeDef
- VerifyTargetDomainInputTypeDef
- AWSResourcesOutputTypeDef
- AWSResourcesTypeDef
- VpcConfigUnionTypeDef
- ActorOutputTypeDef
- ActorTypeDef
- AddArtifactInputTypeDef
- SecurityRequirementArtifactTypeDef
- AddArtifactOutputTypeDef
- CreateApplicationResponseTypeDef
- CreateIntegrationOutputTypeDef
- CreatePrivateConnectionOutputTypeDef
- CreateSecurityRequirementPackOutputTypeDef
- DeleteAgentSpaceOutputTypeDef
- DeletePrivateConnectionOutputTypeDef
- DeleteTargetDomainOutputTypeDef
- DescribePrivateConnectionOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetIntegrationOutputTypeDef
- GetSecurityRequirementPackOutputTypeDef
- ImportSecurityRequirementsOutputTypeDef
- InitiateProviderRegistrationOutputTypeDef
- ListTagsForResourceOutputTypeDef
- StartCodeReviewJobOutputTypeDef
- StartPentestJobOutputTypeDef
- StartThreatModelJobOutputTypeDef
- UpdateApplicationResponseTypeDef
- UpdatePrivateConnectionCertificateOutputTypeDef
- UpdateSecurityRequirementPackOutputTypeDef
- VerifyTargetDomainOutputTypeDef
- ListAgentSpacesOutputTypeDef
- ListApplicationsResponseTypeDef
- BatchGetArtifactMetadataOutputTypeDef
- ListArtifactsOutputTypeDef
- GetArtifactOutputTypeDef
- BatchCreateSecurityRequirementsInputTypeDef
- BatchCreateSecurityRequirementsOutputTypeDef
- BatchDeleteSecurityRequirementsOutputTypeDef
- BatchUpdateSecurityRequirementsOutputTypeDef
- BatchDeleteCodeReviewsOutputTypeDef
- BatchDeleteThreatModelsOutputTypeDef
- BatchGetSecurityRequirementsOutputTypeDef
- BatchUpdateSecurityRequirementsInputTypeDef
- LogLocationTypeDef
- CodeRemediationTaskTypeDef
- ListCodeReviewJobsForCodeReviewOutputTypeDef
- ListCodeReviewJobTasksOutputTypeDef
- ListCodeReviewsOutputTypeDef
- CreateThreatInputTypeDef
- CreateThreatOutputTypeDef
- ThreatTypeDef
- UpdateThreatInputTypeDef
- UpdateThreatOutputTypeDef
- StartCodeReviewJobInputTypeDef
- ListDiscoveredEndpointsOutputTypeDef
- DocumentInfoTypeDef
- ListFindingsOutputTypeDef
- GetApplicationResponseTypeDef
- ProviderInputTypeDef
- IntegratedResourceMetadataTypeDef
- IntegratedResourceTypeDef
- ProviderResourceCapabilitiesTypeDef
- VerificationDetailsTypeDef
- ListIntegrationsInputTypeDef
- ListIntegrationsOutputTypeDef
- ListAgentSpacesInputPaginateTypeDef
- ListApplicationsRequestPaginateTypeDef
- ListArtifactsInputPaginateTypeDef
- ListCodeReviewJobTasksInputPaginateTypeDef
- ListCodeReviewJobsForCodeReviewInputPaginateTypeDef
- ListCodeReviewsInputPaginateTypeDef
- ListDiscoveredEndpointsInputPaginateTypeDef
- ListFindingsInputPaginateTypeDef
- ListIntegratedResourcesInputPaginateTypeDef
- ListIntegrationsInputPaginateTypeDef
- ListMembershipsRequestPaginateTypeDef
- ListPentestJobTasksInputPaginateTypeDef
- ListPentestJobsForPentestInputPaginateTypeDef
- ListPentestsInputPaginateTypeDef
- ListPrivateConnectionsInputPaginateTypeDef
- ListSecurityRequirementsInputPaginateTypeDef
- ListTargetDomainsInputPaginateTypeDef
- ListThreatModelJobTasksInputPaginateTypeDef
- ListThreatModelJobsInputPaginateTypeDef
- ListThreatModelsInputPaginateTypeDef
- ListThreatsInputPaginateTypeDef
- ListPentestJobTasksOutputTypeDef
- ListPentestJobsForPentestOutputTypeDef
- ListPentestsOutputTypeDef
- ListPrivateConnectionsOutputTypeDef
- ListSecurityRequirementPacksInputPaginateTypeDef
- ListSecurityRequirementPacksInputTypeDef
- ListSecurityRequirementPacksOutputTypeDef
- ListSecurityRequirementsOutputTypeDef
- ListTargetDomainsOutputTypeDef
- ListThreatModelJobTasksOutputTypeDef
- ListThreatModelJobsOutputTypeDef
- ListThreatModelsOutputTypeDef
- ListThreatsOutputTypeDef
- MemberMetadataTypeDef
- MembershipConfigTypeDef
- NetworkTrafficConfigOutputTypeDef
- NetworkTrafficConfigTypeDef
- PrivateConnectionModeTypeDef
- VerificationScriptTypeDef
- AgentSpaceTypeDef
- CreateAgentSpaceOutputTypeDef
- UpdateAgentSpaceOutputTypeDef
- AWSResourcesUnionTypeDef
- ImportSourceTypeDef
- CodeReviewJobTaskTypeDef
- TaskTypeDef
- ThreatModelJobTaskTypeDef
- BatchGetThreatsOutputTypeDef
- AssetsOutputTypeDef
- AssetsTypeDef
- CodeReviewJobTypeDef
- ThreatModelJobTypeDef
- CreateIntegrationInputTypeDef
- IntegratedResourceInputItemTypeDef
- IntegratedResourceSummaryTypeDef
- CreateTargetDomainOutputTypeDef
- TargetDomainTypeDef
- UpdateTargetDomainOutputTypeDef
- CreateMembershipRequestTypeDef
- MembershipSummaryTypeDef
- PentestJobTypeDef
- NetworkTrafficConfigUnionTypeDef
- CreatePrivateConnectionInputTypeDef
- FindingTypeDef
- BatchGetAgentSpacesOutputTypeDef
- CreateAgentSpaceInputTypeDef
- UpdateAgentSpaceInputTypeDef
- ImportSecurityRequirementsInputTypeDef
- BatchGetCodeReviewJobTasksOutputTypeDef
- BatchGetPentestJobTasksOutputTypeDef
- BatchGetThreatModelJobTasksOutputTypeDef
- CodeReviewTypeDef
- CreateCodeReviewOutputTypeDef
- CreatePentestOutputTypeDef
- CreateThreatModelOutputTypeDef
- PentestTypeDef
- ThreatModelTypeDef
- UpdateCodeReviewOutputTypeDef
- UpdatePentestOutputTypeDef
- UpdateThreatModelOutputTypeDef
- AssetsUnionTypeDef
- BatchGetCodeReviewJobsOutputTypeDef
- BatchGetThreatModelJobsOutputTypeDef
- UpdateIntegratedResourcesInputTypeDef
- ListIntegratedResourcesOutputTypeDef
- BatchGetTargetDomainsOutputTypeDef
- ListMembershipsResponseTypeDef
- BatchGetPentestJobsOutputTypeDef
- BatchGetFindingsOutputTypeDef
- BatchGetCodeReviewsOutputTypeDef
- BatchDeletePentestsOutputTypeDef
- BatchGetPentestsOutputTypeDef
- BatchGetThreatModelsOutputTypeDef
- CreateCodeReviewInputTypeDef
- CreatePentestInputTypeDef
- CreateThreatModelInputTypeDef
- UpdateCodeReviewInputTypeDef
- UpdatePentestInputTypeDef
- UpdateThreatModelInputTypeDef