Skip to content

Type definitions#

Index > SecurityAgent > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from types_boto3_securityagent.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

VpcConfigUnionTypeDef#

# VpcConfigUnionTypeDef Union usage example

from types_boto3_securityagent.type_defs import VpcConfigUnionTypeDef


def get_value() -> VpcConfigUnionTypeDef:
    return ...


# VpcConfigUnionTypeDef definition

VpcConfigUnionTypeDef = Union[
    VpcConfigTypeDef,  # (1)
    VpcConfigOutputTypeDef,  # (2)
]
  1. See VpcConfigTypeDef
  2. See VpcConfigOutputTypeDef

AWSResourcesUnionTypeDef#

# AWSResourcesUnionTypeDef Union usage example

from types_boto3_securityagent.type_defs import AWSResourcesUnionTypeDef


def get_value() -> AWSResourcesUnionTypeDef:
    return ...


# AWSResourcesUnionTypeDef definition

AWSResourcesUnionTypeDef = Union[
    AWSResourcesTypeDef,  # (1)
    AWSResourcesOutputTypeDef,  # (2)
]
  1. See AWSResourcesTypeDef
  2. See AWSResourcesOutputTypeDef

NetworkTrafficConfigUnionTypeDef#

# NetworkTrafficConfigUnionTypeDef Union usage example

from types_boto3_securityagent.type_defs import NetworkTrafficConfigUnionTypeDef


def get_value() -> NetworkTrafficConfigUnionTypeDef:
    return ...


# NetworkTrafficConfigUnionTypeDef definition

NetworkTrafficConfigUnionTypeDef = Union[
    NetworkTrafficConfigTypeDef,  # (1)
    NetworkTrafficConfigOutputTypeDef,  # (2)
]
  1. See NetworkTrafficConfigTypeDef
  2. See NetworkTrafficConfigOutputTypeDef

AssetsUnionTypeDef#

# AssetsUnionTypeDef Union usage example

from types_boto3_securityagent.type_defs import AssetsUnionTypeDef


def get_value() -> AssetsUnionTypeDef:
    return ...


# AssetsUnionTypeDef definition

AssetsUnionTypeDef = Union[
    AssetsTypeDef,  # (1)
    AssetsOutputTypeDef,  # (2)
]
  1. See AssetsTypeDef
  2. See AssetsOutputTypeDef

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import VpcConfigOutputTypeDef


def get_value() -> VpcConfigOutputTypeDef:
    return {
        "vpcArn": ...,
    }


# VpcConfigOutputTypeDef definition

class VpcConfigOutputTypeDef(TypedDict):
    vpcArn: NotRequired[str],
    securityGroupArns: NotRequired[list[str]],
    subnetArns: NotRequired[list[str]],

VpcConfigTypeDef#

# VpcConfigTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import VpcConfigTypeDef


def get_value() -> VpcConfigTypeDef:
    return {
        "vpcArn": ...,
    }


# VpcConfigTypeDef definition

class VpcConfigTypeDef(TypedDict):
    vpcArn: NotRequired[str],
    securityGroupArns: NotRequired[Sequence[str]],
    subnetArns: NotRequired[Sequence[str]],

AuthenticationTypeDef#

# AuthenticationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AuthenticationTypeDef


def get_value() -> AuthenticationTypeDef:
    return {
        "providerType": ...,
    }


# AuthenticationTypeDef definition

class AuthenticationTypeDef(TypedDict):
    providerType: NotRequired[AuthenticationProviderTypeType],  # (1)
    value: NotRequired[str],
  1. See AuthenticationProviderTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AgentSpaceSummaryTypeDef#

# AgentSpaceSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AgentSpaceSummaryTypeDef


def get_value() -> AgentSpaceSummaryTypeDef:
    return {
        "agentSpaceId": ...,
    }


# AgentSpaceSummaryTypeDef definition

class AgentSpaceSummaryTypeDef(TypedDict):
    agentSpaceId: str,
    name: str,
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],

CodeReviewSettingsTypeDef#

# CodeReviewSettingsTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CodeReviewSettingsTypeDef


def get_value() -> CodeReviewSettingsTypeDef:
    return {
        "controlsScanning": ...,
    }


# CodeReviewSettingsTypeDef definition

class CodeReviewSettingsTypeDef(TypedDict):
    controlsScanning: bool,
    generalPurposeScanning: bool,

ApplicationSummaryTypeDef#

# ApplicationSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ApplicationSummaryTypeDef


def get_value() -> ApplicationSummaryTypeDef:
    return {
        "applicationId": ...,
    }


# ApplicationSummaryTypeDef definition

class ApplicationSummaryTypeDef(TypedDict):
    applicationId: str,
    applicationName: str,
    domain: str,
    defaultKmsKeyId: NotRequired[str],

ArtifactMetadataItemTypeDef#

# ArtifactMetadataItemTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ArtifactMetadataItemTypeDef


def get_value() -> ArtifactMetadataItemTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ArtifactMetadataItemTypeDef definition

class ArtifactMetadataItemTypeDef(TypedDict):
    agentSpaceId: str,
    artifactId: str,
    fileName: str,
    updatedAt: datetime.datetime,

ArtifactSummaryTypeDef#

# ArtifactSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ArtifactSummaryTypeDef


def get_value() -> ArtifactSummaryTypeDef:
    return {
        "artifactId": ...,
    }


# ArtifactSummaryTypeDef definition

class ArtifactSummaryTypeDef(TypedDict):
    artifactId: str,
    fileName: str,
    artifactType: ArtifactTypeType,  # (1)
  1. See ArtifactTypeType

ArtifactTypeDef#

# ArtifactTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ArtifactTypeDef


def get_value() -> ArtifactTypeDef:
    return {
        "contents": ...,
    }


# ArtifactTypeDef definition

class ArtifactTypeDef(TypedDict):
    contents: str,
    type: ArtifactTypeType,  # (1)
  1. See ArtifactTypeType

DocumentInfoTypeDef#

# DocumentInfoTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DocumentInfoTypeDef


def get_value() -> DocumentInfoTypeDef:
    return {
        "s3Location": ...,
    }


# DocumentInfoTypeDef definition

class DocumentInfoTypeDef(TypedDict):
    s3Location: NotRequired[str],
    artifactId: NotRequired[str],

EndpointTypeDef#

# EndpointTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import EndpointTypeDef


def get_value() -> EndpointTypeDef:
    return {
        "uri": ...,
    }


# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    uri: NotRequired[str],

IntegratedRepositoryTypeDef#

# IntegratedRepositoryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegratedRepositoryTypeDef


def get_value() -> IntegratedRepositoryTypeDef:
    return {
        "integrationId": ...,
    }


# IntegratedRepositoryTypeDef definition

class IntegratedRepositoryTypeDef(TypedDict):
    integrationId: str,
    providerResourceId: str,

SourceCodeRepositoryTypeDef#

# SourceCodeRepositoryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import SourceCodeRepositoryTypeDef


def get_value() -> SourceCodeRepositoryTypeDef:
    return {
        "s3Location": ...,
    }


# SourceCodeRepositoryTypeDef definition

class SourceCodeRepositoryTypeDef(TypedDict):
    s3Location: NotRequired[str],

BatchDeletePentestsInputTypeDef#

# BatchDeletePentestsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchDeletePentestsInputTypeDef


def get_value() -> BatchDeletePentestsInputTypeDef:
    return {
        "pentestIds": ...,
    }


# BatchDeletePentestsInputTypeDef definition

class BatchDeletePentestsInputTypeDef(TypedDict):
    pentestIds: Sequence[str],
    agentSpaceId: str,

DeletePentestFailureTypeDef#

# DeletePentestFailureTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeletePentestFailureTypeDef


def get_value() -> DeletePentestFailureTypeDef:
    return {
        "pentestId": ...,
    }


# DeletePentestFailureTypeDef definition

class DeletePentestFailureTypeDef(TypedDict):
    pentestId: NotRequired[str],
    reason: NotRequired[str],

BatchGetAgentSpacesInputTypeDef#

# BatchGetAgentSpacesInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetAgentSpacesInputTypeDef


def get_value() -> BatchGetAgentSpacesInputTypeDef:
    return {
        "agentSpaceIds": ...,
    }


# BatchGetAgentSpacesInputTypeDef definition

class BatchGetAgentSpacesInputTypeDef(TypedDict):
    agentSpaceIds: Sequence[str],

BatchGetArtifactMetadataInputTypeDef#

# BatchGetArtifactMetadataInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetArtifactMetadataInputTypeDef


def get_value() -> BatchGetArtifactMetadataInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# BatchGetArtifactMetadataInputTypeDef definition

class BatchGetArtifactMetadataInputTypeDef(TypedDict):
    agentSpaceId: str,
    artifactIds: Sequence[str],

BatchGetFindingsInputTypeDef#

# BatchGetFindingsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetFindingsInputTypeDef


def get_value() -> BatchGetFindingsInputTypeDef:
    return {
        "findingIds": ...,
    }


# BatchGetFindingsInputTypeDef definition

class BatchGetFindingsInputTypeDef(TypedDict):
    findingIds: Sequence[str],
    agentSpaceId: str,

BatchGetPentestJobTasksInputTypeDef#

# BatchGetPentestJobTasksInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestJobTasksInputTypeDef


def get_value() -> BatchGetPentestJobTasksInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# BatchGetPentestJobTasksInputTypeDef definition

class BatchGetPentestJobTasksInputTypeDef(TypedDict):
    agentSpaceId: str,
    taskIds: Sequence[str],

BatchGetPentestJobsInputTypeDef#

# BatchGetPentestJobsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestJobsInputTypeDef


def get_value() -> BatchGetPentestJobsInputTypeDef:
    return {
        "pentestJobIds": ...,
    }


# BatchGetPentestJobsInputTypeDef definition

class BatchGetPentestJobsInputTypeDef(TypedDict):
    pentestJobIds: Sequence[str],
    agentSpaceId: str,

BatchGetPentestsInputTypeDef#

# BatchGetPentestsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestsInputTypeDef


def get_value() -> BatchGetPentestsInputTypeDef:
    return {
        "pentestIds": ...,
    }


# BatchGetPentestsInputTypeDef definition

class BatchGetPentestsInputTypeDef(TypedDict):
    pentestIds: Sequence[str],
    agentSpaceId: str,

BatchGetTargetDomainsInputTypeDef#

# BatchGetTargetDomainsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetTargetDomainsInputTypeDef


def get_value() -> BatchGetTargetDomainsInputTypeDef:
    return {
        "targetDomainIds": ...,
    }


# BatchGetTargetDomainsInputTypeDef definition

class BatchGetTargetDomainsInputTypeDef(TypedDict):
    targetDomainIds: Sequence[str],

CategoryTypeDef#

# CategoryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CategoryTypeDef


def get_value() -> CategoryTypeDef:
    return {
        "name": ...,
    }


# CategoryTypeDef definition

class CategoryTypeDef(TypedDict):
    name: NotRequired[str],
    isPrimary: NotRequired[bool],

CloudWatchLogTypeDef#

# CloudWatchLogTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CloudWatchLogTypeDef


def get_value() -> CloudWatchLogTypeDef:
    return {
        "logGroup": ...,
    }


# CloudWatchLogTypeDef definition

class CloudWatchLogTypeDef(TypedDict):
    logGroup: NotRequired[str],
    logStream: NotRequired[str],

CodeRemediationTaskDetailsTypeDef#

# CodeRemediationTaskDetailsTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CodeRemediationTaskDetailsTypeDef


def get_value() -> CodeRemediationTaskDetailsTypeDef:
    return {
        "repoName": ...,
    }


# CodeRemediationTaskDetailsTypeDef definition

class CodeRemediationTaskDetailsTypeDef(TypedDict):
    repoName: NotRequired[str],
    codeDiffLink: NotRequired[str],
    pullRequestLink: NotRequired[str],

CreateApplicationRequestTypeDef#

# CreateApplicationRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateApplicationRequestTypeDef


def get_value() -> CreateApplicationRequestTypeDef:
    return {
        "idcInstanceArn": ...,
    }


# CreateApplicationRequestTypeDef definition

class CreateApplicationRequestTypeDef(TypedDict):
    idcInstanceArn: NotRequired[str],
    roleArn: NotRequired[str],
    defaultKmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateTargetDomainInputTypeDef#

# CreateTargetDomainInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateTargetDomainInputTypeDef


def get_value() -> CreateTargetDomainInputTypeDef:
    return {
        "targetDomainName": ...,
    }


# CreateTargetDomainInputTypeDef definition

class CreateTargetDomainInputTypeDef(TypedDict):
    targetDomainName: str,
    verificationMethod: DomainVerificationMethodType,  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See DomainVerificationMethodType

CustomHeaderTypeDef#

# CustomHeaderTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CustomHeaderTypeDef


def get_value() -> CustomHeaderTypeDef:
    return {
        "name": ...,
    }


# CustomHeaderTypeDef definition

class CustomHeaderTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

DeleteAgentSpaceInputTypeDef#

# DeleteAgentSpaceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteAgentSpaceInputTypeDef


def get_value() -> DeleteAgentSpaceInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# DeleteAgentSpaceInputTypeDef definition

class DeleteAgentSpaceInputTypeDef(TypedDict):
    agentSpaceId: str,

DeleteApplicationRequestTypeDef#

# DeleteApplicationRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteApplicationRequestTypeDef


def get_value() -> DeleteApplicationRequestTypeDef:
    return {
        "applicationId": ...,
    }


# DeleteApplicationRequestTypeDef definition

class DeleteApplicationRequestTypeDef(TypedDict):
    applicationId: str,

DeleteArtifactInputTypeDef#

# DeleteArtifactInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteArtifactInputTypeDef


def get_value() -> DeleteArtifactInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# DeleteArtifactInputTypeDef definition

class DeleteArtifactInputTypeDef(TypedDict):
    agentSpaceId: str,
    artifactId: str,

DeleteIntegrationInputTypeDef#

# DeleteIntegrationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteIntegrationInputTypeDef


def get_value() -> DeleteIntegrationInputTypeDef:
    return {
        "integrationId": ...,
    }


# DeleteIntegrationInputTypeDef definition

class DeleteIntegrationInputTypeDef(TypedDict):
    integrationId: str,

DeleteMembershipRequestTypeDef#

# DeleteMembershipRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteMembershipRequestTypeDef


def get_value() -> DeleteMembershipRequestTypeDef:
    return {
        "applicationId": ...,
    }


# DeleteMembershipRequestTypeDef definition

class DeleteMembershipRequestTypeDef(TypedDict):
    applicationId: str,
    agentSpaceId: str,
    membershipId: str,
    memberType: NotRequired[MembershipTypeType],  # (1)
  1. See MembershipTypeType

DeleteTargetDomainInputTypeDef#

# DeleteTargetDomainInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteTargetDomainInputTypeDef


def get_value() -> DeleteTargetDomainInputTypeDef:
    return {
        "targetDomainId": ...,
    }


# DeleteTargetDomainInputTypeDef definition

class DeleteTargetDomainInputTypeDef(TypedDict):
    targetDomainId: str,

DiscoveredEndpointTypeDef#

# DiscoveredEndpointTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DiscoveredEndpointTypeDef


def get_value() -> DiscoveredEndpointTypeDef:
    return {
        "uri": ...,
    }


# DiscoveredEndpointTypeDef definition

class DiscoveredEndpointTypeDef(TypedDict):
    uri: str,
    pentestJobId: str,
    taskId: str,
    agentSpaceId: str,
    evidence: NotRequired[str],
    operation: NotRequired[str],
    description: NotRequired[str],

DnsVerificationTypeDef#

# DnsVerificationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DnsVerificationTypeDef


def get_value() -> DnsVerificationTypeDef:
    return {
        "token": ...,
    }


# DnsVerificationTypeDef definition

class DnsVerificationTypeDef(TypedDict):
    token: NotRequired[str],
    dnsRecordName: NotRequired[str],
    dnsRecordType: NotRequired[DNSRecordTypeType],  # (1)
  1. See DNSRecordTypeType

ErrorInformationTypeDef#

# ErrorInformationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ErrorInformationTypeDef


def get_value() -> ErrorInformationTypeDef:
    return {
        "code": ...,
    }


# ErrorInformationTypeDef definition

class ErrorInformationTypeDef(TypedDict):
    code: NotRequired[ErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See ErrorCodeType

ExecutionContextTypeDef#

# ExecutionContextTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ExecutionContextTypeDef


def get_value() -> ExecutionContextTypeDef:
    return {
        "contextType": ...,
    }


# ExecutionContextTypeDef definition

class ExecutionContextTypeDef(TypedDict):
    contextType: NotRequired[ContextTypeType],  # (1)
    context: NotRequired[str],
    timestamp: NotRequired[datetime.datetime],
  1. See ContextTypeType

FindingSummaryTypeDef#

# FindingSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import FindingSummaryTypeDef


def get_value() -> FindingSummaryTypeDef:
    return {
        "findingId": ...,
    }


# FindingSummaryTypeDef definition

class FindingSummaryTypeDef(TypedDict):
    findingId: str,
    agentSpaceId: str,
    pentestId: NotRequired[str],
    pentestJobId: NotRequired[str],
    name: NotRequired[str],
    status: NotRequired[FindingStatusType],  # (1)
    riskType: NotRequired[str],
    riskLevel: NotRequired[RiskLevelType],  # (2)
    confidence: NotRequired[ConfidenceLevelType],  # (3)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See FindingStatusType
  2. See RiskLevelType
  3. See ConfidenceLevelType

GetApplicationRequestTypeDef#

# GetApplicationRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetApplicationRequestTypeDef


def get_value() -> GetApplicationRequestTypeDef:
    return {
        "applicationId": ...,
    }


# GetApplicationRequestTypeDef definition

class GetApplicationRequestTypeDef(TypedDict):
    applicationId: str,

IdCConfigurationTypeDef#

# IdCConfigurationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IdCConfigurationTypeDef


def get_value() -> IdCConfigurationTypeDef:
    return {
        "idcApplicationArn": ...,
    }


# IdCConfigurationTypeDef definition

class IdCConfigurationTypeDef(TypedDict):
    idcApplicationArn: NotRequired[str],
    idcInstanceArn: NotRequired[str],

GetArtifactInputTypeDef#

# GetArtifactInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetArtifactInputTypeDef


def get_value() -> GetArtifactInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# GetArtifactInputTypeDef definition

class GetArtifactInputTypeDef(TypedDict):
    agentSpaceId: str,
    artifactId: str,

GetIntegrationInputTypeDef#

# GetIntegrationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetIntegrationInputTypeDef


def get_value() -> GetIntegrationInputTypeDef:
    return {
        "integrationId": ...,
    }


# GetIntegrationInputTypeDef definition

class GetIntegrationInputTypeDef(TypedDict):
    integrationId: str,

GitHubIntegrationInputTypeDef#

# GitHubIntegrationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GitHubIntegrationInputTypeDef


def get_value() -> GitHubIntegrationInputTypeDef:
    return {
        "code": ...,
    }


# GitHubIntegrationInputTypeDef definition

class GitHubIntegrationInputTypeDef(TypedDict):
    code: str,
    state: str,
    organizationName: NotRequired[str],

GitHubRepositoryMetadataTypeDef#

# GitHubRepositoryMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GitHubRepositoryMetadataTypeDef


def get_value() -> GitHubRepositoryMetadataTypeDef:
    return {
        "name": ...,
    }


# GitHubRepositoryMetadataTypeDef definition

class GitHubRepositoryMetadataTypeDef(TypedDict):
    name: str,
    providerResourceId: str,
    owner: str,
    accessType: NotRequired[AccessTypeType],  # (1)
  1. See AccessTypeType

GitHubRepositoryResourceTypeDef#

# GitHubRepositoryResourceTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GitHubRepositoryResourceTypeDef


def get_value() -> GitHubRepositoryResourceTypeDef:
    return {
        "name": ...,
    }


# GitHubRepositoryResourceTypeDef definition

class GitHubRepositoryResourceTypeDef(TypedDict):
    name: str,
    owner: str,

GitHubResourceCapabilitiesTypeDef#

# GitHubResourceCapabilitiesTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GitHubResourceCapabilitiesTypeDef


def get_value() -> GitHubResourceCapabilitiesTypeDef:
    return {
        "leaveComments": ...,
    }


# GitHubResourceCapabilitiesTypeDef definition

class GitHubResourceCapabilitiesTypeDef(TypedDict):
    leaveComments: NotRequired[bool],
    remediateCode: NotRequired[bool],

HttpVerificationTypeDef#

# HttpVerificationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import HttpVerificationTypeDef


def get_value() -> HttpVerificationTypeDef:
    return {
        "token": ...,
    }


# HttpVerificationTypeDef definition

class HttpVerificationTypeDef(TypedDict):
    token: NotRequired[str],
    routePath: NotRequired[str],

InitiateProviderRegistrationInputTypeDef#

# InitiateProviderRegistrationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import InitiateProviderRegistrationInputTypeDef


def get_value() -> InitiateProviderRegistrationInputTypeDef:
    return {
        "provider": ...,
    }


# InitiateProviderRegistrationInputTypeDef definition

class InitiateProviderRegistrationInputTypeDef(TypedDict):
    provider: ProviderType,  # (1)
  1. See ProviderType

IntegrationFilterTypeDef#

# IntegrationFilterTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegrationFilterTypeDef


def get_value() -> IntegrationFilterTypeDef:
    return {
        "provider": ...,
    }


# IntegrationFilterTypeDef definition

class IntegrationFilterTypeDef(TypedDict):
    provider: NotRequired[ProviderType],  # (1)
    providerType: NotRequired[ProviderTypeType],  # (2)
  1. See ProviderType
  2. See ProviderTypeType

IntegrationSummaryTypeDef#

# IntegrationSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegrationSummaryTypeDef


def get_value() -> IntegrationSummaryTypeDef:
    return {
        "integrationId": ...,
    }


# IntegrationSummaryTypeDef definition

class IntegrationSummaryTypeDef(TypedDict):
    integrationId: str,
    installationId: str,
    provider: ProviderType,  # (1)
    providerType: ProviderTypeType,  # (2)
    displayName: str,
  1. See ProviderType
  2. See ProviderTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAgentSpacesInputTypeDef#

# ListAgentSpacesInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListAgentSpacesInputTypeDef


def get_value() -> ListAgentSpacesInputTypeDef:
    return {
        "nextToken": ...,
    }


# ListAgentSpacesInputTypeDef definition

class ListAgentSpacesInputTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListApplicationsRequestTypeDef#

# ListApplicationsRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListApplicationsRequestTypeDef


def get_value() -> ListApplicationsRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListApplicationsRequestTypeDef definition

class ListApplicationsRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListArtifactsInputTypeDef#

# ListArtifactsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListArtifactsInputTypeDef


def get_value() -> ListArtifactsInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListArtifactsInputTypeDef definition

class ListArtifactsInputTypeDef(TypedDict):
    agentSpaceId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDiscoveredEndpointsInputTypeDef#

# ListDiscoveredEndpointsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListDiscoveredEndpointsInputTypeDef


def get_value() -> ListDiscoveredEndpointsInputTypeDef:
    return {
        "pentestJobId": ...,
    }


# ListDiscoveredEndpointsInputTypeDef definition

class ListDiscoveredEndpointsInputTypeDef(TypedDict):
    pentestJobId: str,
    agentSpaceId: str,
    maxResults: NotRequired[int],
    prefix: NotRequired[str],
    nextToken: NotRequired[str],

ListFindingsInputTypeDef#

# ListFindingsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListFindingsInputTypeDef


def get_value() -> ListFindingsInputTypeDef:
    return {
        "pentestJobId": ...,
    }


# ListFindingsInputTypeDef definition

class ListFindingsInputTypeDef(TypedDict):
    pentestJobId: str,
    agentSpaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    riskType: NotRequired[str],
    riskLevel: NotRequired[RiskLevelType],  # (1)
    status: NotRequired[FindingStatusType],  # (2)
    confidence: NotRequired[ConfidenceLevelType],  # (3)
    name: NotRequired[str],
  1. See RiskLevelType
  2. See FindingStatusType
  3. See ConfidenceLevelType

ListIntegratedResourcesInputTypeDef#

# ListIntegratedResourcesInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegratedResourcesInputTypeDef


def get_value() -> ListIntegratedResourcesInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListIntegratedResourcesInputTypeDef definition

class ListIntegratedResourcesInputTypeDef(TypedDict):
    agentSpaceId: str,
    integrationId: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ResourceTypeType

ListMembershipsRequestTypeDef#

# ListMembershipsRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListMembershipsRequestTypeDef


def get_value() -> ListMembershipsRequestTypeDef:
    return {
        "applicationId": ...,
    }


# ListMembershipsRequestTypeDef definition

class ListMembershipsRequestTypeDef(TypedDict):
    applicationId: str,
    agentSpaceId: str,
    memberType: NotRequired[MembershipTypeFilterType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See MembershipTypeFilterType

ListPentestJobTasksInputTypeDef#

# ListPentestJobTasksInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobTasksInputTypeDef


def get_value() -> ListPentestJobTasksInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListPentestJobTasksInputTypeDef definition

class ListPentestJobTasksInputTypeDef(TypedDict):
    agentSpaceId: str,
    maxResults: NotRequired[int],
    pentestJobId: NotRequired[str],
    stepName: NotRequired[StepNameType],  # (1)
    categoryName: NotRequired[str],
    nextToken: NotRequired[str],
  1. See StepNameType

TaskSummaryTypeDef#

# TaskSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import TaskSummaryTypeDef


def get_value() -> TaskSummaryTypeDef:
    return {
        "taskId": ...,
    }


# TaskSummaryTypeDef definition

class TaskSummaryTypeDef(TypedDict):
    taskId: str,
    pentestId: NotRequired[str],
    pentestJobId: NotRequired[str],
    agentSpaceId: NotRequired[str],
    title: NotRequired[str],
    riskType: NotRequired[RiskTypeType],  # (1)
    executionStatus: NotRequired[TaskExecutionStatusType],  # (2)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See RiskTypeType
  2. See TaskExecutionStatusType

ListPentestJobsForPentestInputTypeDef#

# ListPentestJobsForPentestInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobsForPentestInputTypeDef


def get_value() -> ListPentestJobsForPentestInputTypeDef:
    return {
        "pentestId": ...,
    }


# ListPentestJobsForPentestInputTypeDef definition

class ListPentestJobsForPentestInputTypeDef(TypedDict):
    pentestId: str,
    agentSpaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PentestJobSummaryTypeDef#

# PentestJobSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import PentestJobSummaryTypeDef


def get_value() -> PentestJobSummaryTypeDef:
    return {
        "pentestJobId": ...,
    }


# PentestJobSummaryTypeDef definition

class PentestJobSummaryTypeDef(TypedDict):
    pentestJobId: str,
    pentestId: str,
    title: NotRequired[str],
    status: NotRequired[JobStatusType],  # (1)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See JobStatusType

ListPentestsInputTypeDef#

# ListPentestsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestsInputTypeDef


def get_value() -> ListPentestsInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListPentestsInputTypeDef definition

class ListPentestsInputTypeDef(TypedDict):
    agentSpaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PentestSummaryTypeDef#

# PentestSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import PentestSummaryTypeDef


def get_value() -> PentestSummaryTypeDef:
    return {
        "pentestId": ...,
    }


# PentestSummaryTypeDef definition

class PentestSummaryTypeDef(TypedDict):
    pentestId: str,
    agentSpaceId: str,
    title: str,
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    resourceArn: str,

ListTargetDomainsInputTypeDef#

# ListTargetDomainsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListTargetDomainsInputTypeDef


def get_value() -> ListTargetDomainsInputTypeDef:
    return {
        "nextToken": ...,
    }


# ListTargetDomainsInputTypeDef definition

class ListTargetDomainsInputTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

TargetDomainSummaryTypeDef#

# TargetDomainSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import TargetDomainSummaryTypeDef


def get_value() -> TargetDomainSummaryTypeDef:
    return {
        "targetDomainId": ...,
    }


# TargetDomainSummaryTypeDef definition

class TargetDomainSummaryTypeDef(TypedDict):
    targetDomainId: str,
    domainName: str,
    verificationStatus: NotRequired[TargetDomainStatusType],  # (1)
  1. See TargetDomainStatusType

UserMetadataTypeDef#

# UserMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UserMetadataTypeDef


def get_value() -> UserMetadataTypeDef:
    return {
        "username": ...,
    }


# UserMetadataTypeDef definition

class UserMetadataTypeDef(TypedDict):
    username: str,
    email: str,

UserConfigTypeDef#

# UserConfigTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UserConfigTypeDef


def get_value() -> UserConfigTypeDef:
    return {
        "role": ...,
    }


# UserConfigTypeDef definition

class UserConfigTypeDef(TypedDict):
    role: NotRequired[UserRoleType],  # (1)
  1. See UserRoleType

NetworkTrafficRuleTypeDef#

# NetworkTrafficRuleTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import NetworkTrafficRuleTypeDef


def get_value() -> NetworkTrafficRuleTypeDef:
    return {
        "effect": ...,
    }


# NetworkTrafficRuleTypeDef definition

class NetworkTrafficRuleTypeDef(TypedDict):
    effect: NotRequired[NetworkTrafficRuleEffectType],  # (1)
    pattern: NotRequired[str],
    networkTrafficRuleType: NotRequired[NetworkTrafficRuleTypeType],  # (2)
  1. See NetworkTrafficRuleEffectType
  2. See NetworkTrafficRuleTypeType

StepTypeDef#

# StepTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import StepTypeDef


def get_value() -> StepTypeDef:
    return {
        "name": ...,
    }


# StepTypeDef definition

class StepTypeDef(TypedDict):
    name: NotRequired[StepNameType],  # (1)
    status: NotRequired[StepStatusType],  # (2)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See StepNameType
  2. See StepStatusType

StartCodeRemediationInputTypeDef#

# StartCodeRemediationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import StartCodeRemediationInputTypeDef


def get_value() -> StartCodeRemediationInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# StartCodeRemediationInputTypeDef definition

class StartCodeRemediationInputTypeDef(TypedDict):
    agentSpaceId: str,
    pentestJobId: str,
    findingIds: Sequence[str],

StartPentestJobInputTypeDef#

# StartPentestJobInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import StartPentestJobInputTypeDef


def get_value() -> StartPentestJobInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# StartPentestJobInputTypeDef definition

class StartPentestJobInputTypeDef(TypedDict):
    agentSpaceId: str,
    pentestId: str,

StopPentestJobInputTypeDef#

# StopPentestJobInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import StopPentestJobInputTypeDef


def get_value() -> StopPentestJobInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# StopPentestJobInputTypeDef definition

class StopPentestJobInputTypeDef(TypedDict):
    agentSpaceId: str,
    pentestJobId: str,

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateApplicationRequestTypeDef#

# UpdateApplicationRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateApplicationRequestTypeDef


def get_value() -> UpdateApplicationRequestTypeDef:
    return {
        "applicationId": ...,
    }


# UpdateApplicationRequestTypeDef definition

class UpdateApplicationRequestTypeDef(TypedDict):
    applicationId: str,
    roleArn: NotRequired[str],
    defaultKmsKeyId: NotRequired[str],

UpdateFindingInputTypeDef#

# UpdateFindingInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateFindingInputTypeDef


def get_value() -> UpdateFindingInputTypeDef:
    return {
        "findingId": ...,
    }


# UpdateFindingInputTypeDef definition

class UpdateFindingInputTypeDef(TypedDict):
    findingId: str,
    agentSpaceId: str,
    riskLevel: NotRequired[RiskLevelType],  # (1)
    status: NotRequired[FindingStatusType],  # (2)
  1. See RiskLevelType
  2. See FindingStatusType

UpdateTargetDomainInputTypeDef#

# UpdateTargetDomainInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateTargetDomainInputTypeDef


def get_value() -> UpdateTargetDomainInputTypeDef:
    return {
        "targetDomainId": ...,
    }


# UpdateTargetDomainInputTypeDef definition

class UpdateTargetDomainInputTypeDef(TypedDict):
    targetDomainId: str,
    verificationMethod: DomainVerificationMethodType,  # (1)
  1. See DomainVerificationMethodType

VerifyTargetDomainInputTypeDef#

# VerifyTargetDomainInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import VerifyTargetDomainInputTypeDef


def get_value() -> VerifyTargetDomainInputTypeDef:
    return {
        "targetDomainId": ...,
    }


# VerifyTargetDomainInputTypeDef definition

class VerifyTargetDomainInputTypeDef(TypedDict):
    targetDomainId: str,

AWSResourcesOutputTypeDef#

# AWSResourcesOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AWSResourcesOutputTypeDef


def get_value() -> AWSResourcesOutputTypeDef:
    return {
        "vpcs": ...,
    }


# AWSResourcesOutputTypeDef definition

class AWSResourcesOutputTypeDef(TypedDict):
    vpcs: NotRequired[list[VpcConfigOutputTypeDef]],  # (1)
    logGroups: NotRequired[list[str]],
    s3Buckets: NotRequired[list[str]],
    secretArns: NotRequired[list[str]],
    lambdaFunctionArns: NotRequired[list[str]],
    iamRoles: NotRequired[list[str]],
  1. See list[VpcConfigOutputTypeDef]

AWSResourcesTypeDef#

# AWSResourcesTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AWSResourcesTypeDef


def get_value() -> AWSResourcesTypeDef:
    return {
        "vpcs": ...,
    }


# AWSResourcesTypeDef definition

class AWSResourcesTypeDef(TypedDict):
    vpcs: NotRequired[Sequence[VpcConfigTypeDef]],  # (1)
    logGroups: NotRequired[Sequence[str]],
    s3Buckets: NotRequired[Sequence[str]],
    secretArns: NotRequired[Sequence[str]],
    lambdaFunctionArns: NotRequired[Sequence[str]],
    iamRoles: NotRequired[Sequence[str]],
  1. See Sequence[VpcConfigTypeDef]

ActorOutputTypeDef#

# ActorOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ActorOutputTypeDef


def get_value() -> ActorOutputTypeDef:
    return {
        "identifier": ...,
    }


# ActorOutputTypeDef definition

class ActorOutputTypeDef(TypedDict):
    identifier: NotRequired[str],
    uris: NotRequired[list[str]],
    authentication: NotRequired[AuthenticationTypeDef],  # (1)
    description: NotRequired[str],
  1. See AuthenticationTypeDef

ActorTypeDef#

# ActorTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ActorTypeDef


def get_value() -> ActorTypeDef:
    return {
        "identifier": ...,
    }


# ActorTypeDef definition

class ActorTypeDef(TypedDict):
    identifier: NotRequired[str],
    uris: NotRequired[Sequence[str]],
    authentication: NotRequired[AuthenticationTypeDef],  # (1)
    description: NotRequired[str],
  1. See AuthenticationTypeDef

AddArtifactInputTypeDef#

# AddArtifactInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AddArtifactInputTypeDef


def get_value() -> AddArtifactInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# AddArtifactInputTypeDef definition

class AddArtifactInputTypeDef(TypedDict):
    agentSpaceId: str,
    artifactContent: BlobTypeDef,
    artifactType: ArtifactTypeType,  # (1)
    fileName: str,
  1. See ArtifactTypeType

AddArtifactOutputTypeDef#

# AddArtifactOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AddArtifactOutputTypeDef


def get_value() -> AddArtifactOutputTypeDef:
    return {
        "artifactId": ...,
    }


# AddArtifactOutputTypeDef definition

class AddArtifactOutputTypeDef(TypedDict):
    artifactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateApplicationResponseTypeDef#

# CreateApplicationResponseTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateApplicationResponseTypeDef


def get_value() -> CreateApplicationResponseTypeDef:
    return {
        "applicationId": ...,
    }


# CreateApplicationResponseTypeDef definition

class CreateApplicationResponseTypeDef(TypedDict):
    applicationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIntegrationOutputTypeDef#

# CreateIntegrationOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateIntegrationOutputTypeDef


def get_value() -> CreateIntegrationOutputTypeDef:
    return {
        "integrationId": ...,
    }


# CreateIntegrationOutputTypeDef definition

class CreateIntegrationOutputTypeDef(TypedDict):
    integrationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteAgentSpaceOutputTypeDef#

# DeleteAgentSpaceOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteAgentSpaceOutputTypeDef


def get_value() -> DeleteAgentSpaceOutputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# DeleteAgentSpaceOutputTypeDef definition

class DeleteAgentSpaceOutputTypeDef(TypedDict):
    agentSpaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTargetDomainOutputTypeDef#

# DeleteTargetDomainOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import DeleteTargetDomainOutputTypeDef


def get_value() -> DeleteTargetDomainOutputTypeDef:
    return {
        "targetDomainId": ...,
    }


# DeleteTargetDomainOutputTypeDef definition

class DeleteTargetDomainOutputTypeDef(TypedDict):
    targetDomainId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetIntegrationOutputTypeDef#

# GetIntegrationOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetIntegrationOutputTypeDef


def get_value() -> GetIntegrationOutputTypeDef:
    return {
        "integrationId": ...,
    }


# GetIntegrationOutputTypeDef definition

class GetIntegrationOutputTypeDef(TypedDict):
    integrationId: str,
    installationId: str,
    provider: ProviderType,  # (1)
    providerType: ProviderTypeType,  # (2)
    displayName: str,
    kmsKeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ProviderType
  2. See ProviderTypeType
  3. See ResponseMetadataTypeDef

InitiateProviderRegistrationOutputTypeDef#

# InitiateProviderRegistrationOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import InitiateProviderRegistrationOutputTypeDef


def get_value() -> InitiateProviderRegistrationOutputTypeDef:
    return {
        "redirectTo": ...,
    }


# InitiateProviderRegistrationOutputTypeDef definition

class InitiateProviderRegistrationOutputTypeDef(TypedDict):
    redirectTo: str,
    csrfState: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPentestJobOutputTypeDef#

# StartPentestJobOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import StartPentestJobOutputTypeDef


def get_value() -> StartPentestJobOutputTypeDef:
    return {
        "title": ...,
    }


# StartPentestJobOutputTypeDef definition

class StartPentestJobOutputTypeDef(TypedDict):
    title: str,
    status: JobStatusType,  # (1)
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    pentestId: str,
    pentestJobId: str,
    agentSpaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

UpdateApplicationResponseTypeDef#

# UpdateApplicationResponseTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateApplicationResponseTypeDef


def get_value() -> UpdateApplicationResponseTypeDef:
    return {
        "applicationId": ...,
    }


# UpdateApplicationResponseTypeDef definition

class UpdateApplicationResponseTypeDef(TypedDict):
    applicationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

VerifyTargetDomainOutputTypeDef#

# VerifyTargetDomainOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import VerifyTargetDomainOutputTypeDef


def get_value() -> VerifyTargetDomainOutputTypeDef:
    return {
        "targetDomainId": ...,
    }


# VerifyTargetDomainOutputTypeDef definition

class VerifyTargetDomainOutputTypeDef(TypedDict):
    targetDomainId: str,
    domainName: str,
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    verifiedAt: datetime.datetime,
    status: TargetDomainStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TargetDomainStatusType
  2. See ResponseMetadataTypeDef

ListAgentSpacesOutputTypeDef#

# ListAgentSpacesOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListAgentSpacesOutputTypeDef


def get_value() -> ListAgentSpacesOutputTypeDef:
    return {
        "agentSpaceSummaries": ...,
    }


# ListAgentSpacesOutputTypeDef definition

class ListAgentSpacesOutputTypeDef(TypedDict):
    agentSpaceSummaries: list[AgentSpaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[AgentSpaceSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListApplicationsResponseTypeDef#

# ListApplicationsResponseTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListApplicationsResponseTypeDef


def get_value() -> ListApplicationsResponseTypeDef:
    return {
        "applicationSummaries": ...,
    }


# ListApplicationsResponseTypeDef definition

class ListApplicationsResponseTypeDef(TypedDict):
    applicationSummaries: list[ApplicationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[ApplicationSummaryTypeDef]
  2. See ResponseMetadataTypeDef

BatchGetArtifactMetadataOutputTypeDef#

# BatchGetArtifactMetadataOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetArtifactMetadataOutputTypeDef


def get_value() -> BatchGetArtifactMetadataOutputTypeDef:
    return {
        "artifactMetadataList": ...,
    }


# BatchGetArtifactMetadataOutputTypeDef definition

class BatchGetArtifactMetadataOutputTypeDef(TypedDict):
    artifactMetadataList: list[ArtifactMetadataItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[ArtifactMetadataItemTypeDef]
  2. See ResponseMetadataTypeDef

ListArtifactsOutputTypeDef#

# ListArtifactsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListArtifactsOutputTypeDef


def get_value() -> ListArtifactsOutputTypeDef:
    return {
        "artifactSummaries": ...,
    }


# ListArtifactsOutputTypeDef definition

class ListArtifactsOutputTypeDef(TypedDict):
    artifactSummaries: list[ArtifactSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[ArtifactSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetArtifactOutputTypeDef#

# GetArtifactOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetArtifactOutputTypeDef


def get_value() -> GetArtifactOutputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# GetArtifactOutputTypeDef definition

class GetArtifactOutputTypeDef(TypedDict):
    agentSpaceId: str,
    artifactId: str,
    artifact: ArtifactTypeDef,  # (1)
    fileName: str,
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ArtifactTypeDef
  2. See ResponseMetadataTypeDef

LogLocationTypeDef#

# LogLocationTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import LogLocationTypeDef


def get_value() -> LogLocationTypeDef:
    return {
        "logType": ...,
    }


# LogLocationTypeDef definition

class LogLocationTypeDef(TypedDict):
    logType: NotRequired[LogTypeType],  # (1)
    cloudWatchLog: NotRequired[CloudWatchLogTypeDef],  # (2)
  1. See LogTypeType
  2. See CloudWatchLogTypeDef

CodeRemediationTaskTypeDef#

# CodeRemediationTaskTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CodeRemediationTaskTypeDef


def get_value() -> CodeRemediationTaskTypeDef:
    return {
        "status": ...,
    }


# CodeRemediationTaskTypeDef definition

class CodeRemediationTaskTypeDef(TypedDict):
    status: CodeRemediationTaskStatusType,  # (1)
    statusReason: NotRequired[str],
    taskDetails: NotRequired[list[CodeRemediationTaskDetailsTypeDef]],  # (2)
  1. See CodeRemediationTaskStatusType
  2. See list[CodeRemediationTaskDetailsTypeDef]

ListDiscoveredEndpointsOutputTypeDef#

# ListDiscoveredEndpointsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListDiscoveredEndpointsOutputTypeDef


def get_value() -> ListDiscoveredEndpointsOutputTypeDef:
    return {
        "discoveredEndpoints": ...,
    }


# ListDiscoveredEndpointsOutputTypeDef definition

class ListDiscoveredEndpointsOutputTypeDef(TypedDict):
    discoveredEndpoints: list[DiscoveredEndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[DiscoveredEndpointTypeDef]
  2. See ResponseMetadataTypeDef

ListFindingsOutputTypeDef#

# ListFindingsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListFindingsOutputTypeDef


def get_value() -> ListFindingsOutputTypeDef:
    return {
        "findingsSummaries": ...,
    }


# ListFindingsOutputTypeDef definition

class ListFindingsOutputTypeDef(TypedDict):
    findingsSummaries: list[FindingSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[FindingSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetApplicationResponseTypeDef#

# GetApplicationResponseTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import GetApplicationResponseTypeDef


def get_value() -> GetApplicationResponseTypeDef:
    return {
        "applicationId": ...,
    }


# GetApplicationResponseTypeDef definition

class GetApplicationResponseTypeDef(TypedDict):
    applicationId: str,
    domain: str,
    applicationName: str,
    idcConfiguration: IdCConfigurationTypeDef,  # (1)
    roleArn: str,
    defaultKmsKeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdCConfigurationTypeDef
  2. See ResponseMetadataTypeDef

ProviderInputTypeDef#

# ProviderInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ProviderInputTypeDef


def get_value() -> ProviderInputTypeDef:
    return {
        "github": ...,
    }


# ProviderInputTypeDef definition

class ProviderInputTypeDef(TypedDict):
    github: NotRequired[GitHubIntegrationInputTypeDef],  # (1)
  1. See GitHubIntegrationInputTypeDef

IntegratedResourceMetadataTypeDef#

# IntegratedResourceMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegratedResourceMetadataTypeDef


def get_value() -> IntegratedResourceMetadataTypeDef:
    return {
        "githubRepository": ...,
    }


# IntegratedResourceMetadataTypeDef definition

class IntegratedResourceMetadataTypeDef(TypedDict):
    githubRepository: NotRequired[GitHubRepositoryMetadataTypeDef],  # (1)
  1. See GitHubRepositoryMetadataTypeDef

IntegratedResourceTypeDef#

# IntegratedResourceTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegratedResourceTypeDef


def get_value() -> IntegratedResourceTypeDef:
    return {
        "githubRepository": ...,
    }


# IntegratedResourceTypeDef definition

class IntegratedResourceTypeDef(TypedDict):
    githubRepository: NotRequired[GitHubRepositoryResourceTypeDef],  # (1)
  1. See GitHubRepositoryResourceTypeDef

ProviderResourceCapabilitiesTypeDef#

# ProviderResourceCapabilitiesTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ProviderResourceCapabilitiesTypeDef


def get_value() -> ProviderResourceCapabilitiesTypeDef:
    return {
        "github": ...,
    }


# ProviderResourceCapabilitiesTypeDef definition

class ProviderResourceCapabilitiesTypeDef(TypedDict):
    github: NotRequired[GitHubResourceCapabilitiesTypeDef],  # (1)
  1. See GitHubResourceCapabilitiesTypeDef

VerificationDetailsTypeDef#

# VerificationDetailsTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import VerificationDetailsTypeDef


def get_value() -> VerificationDetailsTypeDef:
    return {
        "method": ...,
    }


# VerificationDetailsTypeDef definition

class VerificationDetailsTypeDef(TypedDict):
    method: NotRequired[DomainVerificationMethodType],  # (1)
    dnsTxt: NotRequired[DnsVerificationTypeDef],  # (2)
    httpRoute: NotRequired[HttpVerificationTypeDef],  # (3)
  1. See DomainVerificationMethodType
  2. See DnsVerificationTypeDef
  3. See HttpVerificationTypeDef

ListIntegrationsInputTypeDef#

# ListIntegrationsInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegrationsInputTypeDef


def get_value() -> ListIntegrationsInputTypeDef:
    return {
        "filter": ...,
    }


# ListIntegrationsInputTypeDef definition

class ListIntegrationsInputTypeDef(TypedDict):
    filter: NotRequired[IntegrationFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See IntegrationFilterTypeDef

ListIntegrationsOutputTypeDef#

# ListIntegrationsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegrationsOutputTypeDef


def get_value() -> ListIntegrationsOutputTypeDef:
    return {
        "integrationSummaries": ...,
    }


# ListIntegrationsOutputTypeDef definition

class ListIntegrationsOutputTypeDef(TypedDict):
    integrationSummaries: list[IntegrationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[IntegrationSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListAgentSpacesInputPaginateTypeDef#

# ListAgentSpacesInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListAgentSpacesInputPaginateTypeDef


def get_value() -> ListAgentSpacesInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListAgentSpacesInputPaginateTypeDef definition

class ListAgentSpacesInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListApplicationsRequestPaginateTypeDef#

# ListApplicationsRequestPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListApplicationsRequestPaginateTypeDef


def get_value() -> ListApplicationsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListApplicationsRequestPaginateTypeDef definition

class ListApplicationsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListArtifactsInputPaginateTypeDef#

# ListArtifactsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListArtifactsInputPaginateTypeDef


def get_value() -> ListArtifactsInputPaginateTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListArtifactsInputPaginateTypeDef definition

class ListArtifactsInputPaginateTypeDef(TypedDict):
    agentSpaceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDiscoveredEndpointsInputPaginateTypeDef#

# ListDiscoveredEndpointsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListDiscoveredEndpointsInputPaginateTypeDef


def get_value() -> ListDiscoveredEndpointsInputPaginateTypeDef:
    return {
        "pentestJobId": ...,
    }


# ListDiscoveredEndpointsInputPaginateTypeDef definition

class ListDiscoveredEndpointsInputPaginateTypeDef(TypedDict):
    pentestJobId: str,
    agentSpaceId: str,
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFindingsInputPaginateTypeDef#

# ListFindingsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListFindingsInputPaginateTypeDef


def get_value() -> ListFindingsInputPaginateTypeDef:
    return {
        "pentestJobId": ...,
    }


# ListFindingsInputPaginateTypeDef definition

class ListFindingsInputPaginateTypeDef(TypedDict):
    pentestJobId: str,
    agentSpaceId: str,
    riskType: NotRequired[str],
    riskLevel: NotRequired[RiskLevelType],  # (1)
    status: NotRequired[FindingStatusType],  # (2)
    confidence: NotRequired[ConfidenceLevelType],  # (3)
    name: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See RiskLevelType
  2. See FindingStatusType
  3. See ConfidenceLevelType
  4. See PaginatorConfigTypeDef

ListIntegratedResourcesInputPaginateTypeDef#

# ListIntegratedResourcesInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegratedResourcesInputPaginateTypeDef


def get_value() -> ListIntegratedResourcesInputPaginateTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListIntegratedResourcesInputPaginateTypeDef definition

class ListIntegratedResourcesInputPaginateTypeDef(TypedDict):
    agentSpaceId: str,
    integrationId: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ResourceTypeType
  2. See PaginatorConfigTypeDef

ListIntegrationsInputPaginateTypeDef#

# ListIntegrationsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegrationsInputPaginateTypeDef


def get_value() -> ListIntegrationsInputPaginateTypeDef:
    return {
        "filter": ...,
    }


# ListIntegrationsInputPaginateTypeDef definition

class ListIntegrationsInputPaginateTypeDef(TypedDict):
    filter: NotRequired[IntegrationFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See IntegrationFilterTypeDef
  2. See PaginatorConfigTypeDef

ListMembershipsRequestPaginateTypeDef#

# ListMembershipsRequestPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListMembershipsRequestPaginateTypeDef


def get_value() -> ListMembershipsRequestPaginateTypeDef:
    return {
        "applicationId": ...,
    }


# ListMembershipsRequestPaginateTypeDef definition

class ListMembershipsRequestPaginateTypeDef(TypedDict):
    applicationId: str,
    agentSpaceId: str,
    memberType: NotRequired[MembershipTypeFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MembershipTypeFilterType
  2. See PaginatorConfigTypeDef

ListPentestJobTasksInputPaginateTypeDef#

# ListPentestJobTasksInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobTasksInputPaginateTypeDef


def get_value() -> ListPentestJobTasksInputPaginateTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListPentestJobTasksInputPaginateTypeDef definition

class ListPentestJobTasksInputPaginateTypeDef(TypedDict):
    agentSpaceId: str,
    pentestJobId: NotRequired[str],
    stepName: NotRequired[StepNameType],  # (1)
    categoryName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See StepNameType
  2. See PaginatorConfigTypeDef

ListPentestJobsForPentestInputPaginateTypeDef#

# ListPentestJobsForPentestInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobsForPentestInputPaginateTypeDef


def get_value() -> ListPentestJobsForPentestInputPaginateTypeDef:
    return {
        "pentestId": ...,
    }


# ListPentestJobsForPentestInputPaginateTypeDef definition

class ListPentestJobsForPentestInputPaginateTypeDef(TypedDict):
    pentestId: str,
    agentSpaceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPentestsInputPaginateTypeDef#

# ListPentestsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestsInputPaginateTypeDef


def get_value() -> ListPentestsInputPaginateTypeDef:
    return {
        "agentSpaceId": ...,
    }


# ListPentestsInputPaginateTypeDef definition

class ListPentestsInputPaginateTypeDef(TypedDict):
    agentSpaceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTargetDomainsInputPaginateTypeDef#

# ListTargetDomainsInputPaginateTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListTargetDomainsInputPaginateTypeDef


def get_value() -> ListTargetDomainsInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListTargetDomainsInputPaginateTypeDef definition

class ListTargetDomainsInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPentestJobTasksOutputTypeDef#

# ListPentestJobTasksOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobTasksOutputTypeDef


def get_value() -> ListPentestJobTasksOutputTypeDef:
    return {
        "taskSummaries": ...,
    }


# ListPentestJobTasksOutputTypeDef definition

class ListPentestJobTasksOutputTypeDef(TypedDict):
    taskSummaries: list[TaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[TaskSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListPentestJobsForPentestOutputTypeDef#

# ListPentestJobsForPentestOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestJobsForPentestOutputTypeDef


def get_value() -> ListPentestJobsForPentestOutputTypeDef:
    return {
        "pentestJobSummaries": ...,
    }


# ListPentestJobsForPentestOutputTypeDef definition

class ListPentestJobsForPentestOutputTypeDef(TypedDict):
    pentestJobSummaries: list[PentestJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[PentestJobSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListPentestsOutputTypeDef#

# ListPentestsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListPentestsOutputTypeDef


def get_value() -> ListPentestsOutputTypeDef:
    return {
        "pentestSummaries": ...,
    }


# ListPentestsOutputTypeDef definition

class ListPentestsOutputTypeDef(TypedDict):
    pentestSummaries: list[PentestSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[PentestSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListTargetDomainsOutputTypeDef#

# ListTargetDomainsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListTargetDomainsOutputTypeDef


def get_value() -> ListTargetDomainsOutputTypeDef:
    return {
        "targetDomainSummaries": ...,
    }


# ListTargetDomainsOutputTypeDef definition

class ListTargetDomainsOutputTypeDef(TypedDict):
    targetDomainSummaries: list[TargetDomainSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[TargetDomainSummaryTypeDef]
  2. See ResponseMetadataTypeDef

MemberMetadataTypeDef#

# MemberMetadataTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import MemberMetadataTypeDef


def get_value() -> MemberMetadataTypeDef:
    return {
        "user": ...,
    }


# MemberMetadataTypeDef definition

class MemberMetadataTypeDef(TypedDict):
    user: NotRequired[UserMetadataTypeDef],  # (1)
  1. See UserMetadataTypeDef

MembershipConfigTypeDef#

# MembershipConfigTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import MembershipConfigTypeDef


def get_value() -> MembershipConfigTypeDef:
    return {
        "user": ...,
    }


# MembershipConfigTypeDef definition

class MembershipConfigTypeDef(TypedDict):
    user: NotRequired[UserConfigTypeDef],  # (1)
  1. See UserConfigTypeDef

NetworkTrafficConfigOutputTypeDef#

# NetworkTrafficConfigOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import NetworkTrafficConfigOutputTypeDef


def get_value() -> NetworkTrafficConfigOutputTypeDef:
    return {
        "rules": ...,
    }


# NetworkTrafficConfigOutputTypeDef definition

class NetworkTrafficConfigOutputTypeDef(TypedDict):
    rules: NotRequired[list[NetworkTrafficRuleTypeDef]],  # (1)
    customHeaders: NotRequired[list[CustomHeaderTypeDef]],  # (2)
  1. See list[NetworkTrafficRuleTypeDef]
  2. See list[CustomHeaderTypeDef]

NetworkTrafficConfigTypeDef#

# NetworkTrafficConfigTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import NetworkTrafficConfigTypeDef


def get_value() -> NetworkTrafficConfigTypeDef:
    return {
        "rules": ...,
    }


# NetworkTrafficConfigTypeDef definition

class NetworkTrafficConfigTypeDef(TypedDict):
    rules: NotRequired[Sequence[NetworkTrafficRuleTypeDef]],  # (1)
    customHeaders: NotRequired[Sequence[CustomHeaderTypeDef]],  # (2)
  1. See Sequence[NetworkTrafficRuleTypeDef]
  2. See Sequence[CustomHeaderTypeDef]

AgentSpaceTypeDef#

# AgentSpaceTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AgentSpaceTypeDef


def get_value() -> AgentSpaceTypeDef:
    return {
        "agentSpaceId": ...,
    }


# AgentSpaceTypeDef definition

class AgentSpaceTypeDef(TypedDict):
    agentSpaceId: str,
    name: str,
    description: NotRequired[str],
    awsResources: NotRequired[AWSResourcesOutputTypeDef],  # (1)
    targetDomainIds: NotRequired[list[str]],
    codeReviewSettings: NotRequired[CodeReviewSettingsTypeDef],  # (2)
    kmsKeyId: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See AWSResourcesOutputTypeDef
  2. See CodeReviewSettingsTypeDef

CreateAgentSpaceOutputTypeDef#

# CreateAgentSpaceOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateAgentSpaceOutputTypeDef


def get_value() -> CreateAgentSpaceOutputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# CreateAgentSpaceOutputTypeDef definition

class CreateAgentSpaceOutputTypeDef(TypedDict):
    agentSpaceId: str,
    name: str,
    description: str,
    awsResources: AWSResourcesOutputTypeDef,  # (1)
    targetDomainIds: list[str],
    codeReviewSettings: CodeReviewSettingsTypeDef,  # (2)
    kmsKeyId: str,
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AWSResourcesOutputTypeDef
  2. See CodeReviewSettingsTypeDef
  3. See ResponseMetadataTypeDef

UpdateAgentSpaceOutputTypeDef#

# UpdateAgentSpaceOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateAgentSpaceOutputTypeDef


def get_value() -> UpdateAgentSpaceOutputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# UpdateAgentSpaceOutputTypeDef definition

class UpdateAgentSpaceOutputTypeDef(TypedDict):
    agentSpaceId: str,
    name: str,
    description: str,
    awsResources: AWSResourcesOutputTypeDef,  # (1)
    targetDomainIds: list[str],
    codeReviewSettings: CodeReviewSettingsTypeDef,  # (2)
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AWSResourcesOutputTypeDef
  2. See CodeReviewSettingsTypeDef
  3. See ResponseMetadataTypeDef

AssetsOutputTypeDef#

# AssetsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AssetsOutputTypeDef


def get_value() -> AssetsOutputTypeDef:
    return {
        "endpoints": ...,
    }


# AssetsOutputTypeDef definition

class AssetsOutputTypeDef(TypedDict):
    endpoints: NotRequired[list[EndpointTypeDef]],  # (1)
    actors: NotRequired[list[ActorOutputTypeDef]],  # (2)
    documents: NotRequired[list[DocumentInfoTypeDef]],  # (3)
    sourceCode: NotRequired[list[SourceCodeRepositoryTypeDef]],  # (4)
    integratedRepositories: NotRequired[list[IntegratedRepositoryTypeDef]],  # (5)
  1. See list[EndpointTypeDef]
  2. See list[ActorOutputTypeDef]
  3. See list[DocumentInfoTypeDef]
  4. See list[SourceCodeRepositoryTypeDef]
  5. See list[IntegratedRepositoryTypeDef]

AssetsTypeDef#

# AssetsTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import AssetsTypeDef


def get_value() -> AssetsTypeDef:
    return {
        "endpoints": ...,
    }


# AssetsTypeDef definition

class AssetsTypeDef(TypedDict):
    endpoints: NotRequired[Sequence[EndpointTypeDef]],  # (1)
    actors: NotRequired[Sequence[ActorTypeDef]],  # (2)
    documents: NotRequired[Sequence[DocumentInfoTypeDef]],  # (3)
    sourceCode: NotRequired[Sequence[SourceCodeRepositoryTypeDef]],  # (4)
    integratedRepositories: NotRequired[Sequence[IntegratedRepositoryTypeDef]],  # (5)
  1. See Sequence[EndpointTypeDef]
  2. See Sequence[ActorTypeDef]
  3. See Sequence[DocumentInfoTypeDef]
  4. See Sequence[SourceCodeRepositoryTypeDef]
  5. See Sequence[IntegratedRepositoryTypeDef]

TaskTypeDef#

# TaskTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import TaskTypeDef


def get_value() -> TaskTypeDef:
    return {
        "taskId": ...,
    }


# TaskTypeDef definition

class TaskTypeDef(TypedDict):
    taskId: str,
    pentestId: NotRequired[str],
    pentestJobId: NotRequired[str],
    agentSpaceId: NotRequired[str],
    title: NotRequired[str],
    description: NotRequired[str],
    categories: NotRequired[list[CategoryTypeDef]],  # (1)
    riskType: NotRequired[RiskTypeType],  # (2)
    targetEndpoint: NotRequired[EndpointTypeDef],  # (3)
    executionStatus: NotRequired[TaskExecutionStatusType],  # (4)
    logsLocation: NotRequired[LogLocationTypeDef],  # (5)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See list[CategoryTypeDef]
  2. See RiskTypeType
  3. See EndpointTypeDef
  4. See TaskExecutionStatusType
  5. See LogLocationTypeDef

FindingTypeDef#

# FindingTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import FindingTypeDef


def get_value() -> FindingTypeDef:
    return {
        "findingId": ...,
    }


# FindingTypeDef definition

class FindingTypeDef(TypedDict):
    findingId: str,
    agentSpaceId: str,
    pentestId: NotRequired[str],
    pentestJobId: NotRequired[str],
    taskId: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    status: NotRequired[FindingStatusType],  # (1)
    riskType: NotRequired[str],
    riskLevel: NotRequired[RiskLevelType],  # (2)
    riskScore: NotRequired[str],
    reasoning: NotRequired[str],
    confidence: NotRequired[ConfidenceLevelType],  # (3)
    attackScript: NotRequired[str],
    codeRemediationTask: NotRequired[CodeRemediationTaskTypeDef],  # (4)
    lastUpdatedBy: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See FindingStatusType
  2. See RiskLevelType
  3. See ConfidenceLevelType
  4. See CodeRemediationTaskTypeDef

CreateIntegrationInputTypeDef#

# CreateIntegrationInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateIntegrationInputTypeDef


def get_value() -> CreateIntegrationInputTypeDef:
    return {
        "provider": ...,
    }


# CreateIntegrationInputTypeDef definition

class CreateIntegrationInputTypeDef(TypedDict):
    provider: ProviderType,  # (1)
    input: ProviderInputTypeDef,  # (2)
    integrationDisplayName: str,
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See ProviderType
  2. See ProviderInputTypeDef

IntegratedResourceInputItemTypeDef#

# IntegratedResourceInputItemTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegratedResourceInputItemTypeDef


def get_value() -> IntegratedResourceInputItemTypeDef:
    return {
        "resource": ...,
    }


# IntegratedResourceInputItemTypeDef definition

class IntegratedResourceInputItemTypeDef(TypedDict):
    resource: IntegratedResourceTypeDef,  # (1)
    capabilities: NotRequired[ProviderResourceCapabilitiesTypeDef],  # (2)
  1. See IntegratedResourceTypeDef
  2. See ProviderResourceCapabilitiesTypeDef

IntegratedResourceSummaryTypeDef#

# IntegratedResourceSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import IntegratedResourceSummaryTypeDef


def get_value() -> IntegratedResourceSummaryTypeDef:
    return {
        "integrationId": ...,
    }


# IntegratedResourceSummaryTypeDef definition

class IntegratedResourceSummaryTypeDef(TypedDict):
    integrationId: str,
    resource: IntegratedResourceMetadataTypeDef,  # (1)
    capabilities: NotRequired[ProviderResourceCapabilitiesTypeDef],  # (2)
  1. See IntegratedResourceMetadataTypeDef
  2. See ProviderResourceCapabilitiesTypeDef

CreateTargetDomainOutputTypeDef#

# CreateTargetDomainOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateTargetDomainOutputTypeDef


def get_value() -> CreateTargetDomainOutputTypeDef:
    return {
        "targetDomainId": ...,
    }


# CreateTargetDomainOutputTypeDef definition

class CreateTargetDomainOutputTypeDef(TypedDict):
    targetDomainId: str,
    domainName: str,
    verificationStatus: TargetDomainStatusType,  # (1)
    verificationDetails: VerificationDetailsTypeDef,  # (2)
    createdAt: datetime.datetime,
    verifiedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TargetDomainStatusType
  2. See VerificationDetailsTypeDef
  3. See ResponseMetadataTypeDef

TargetDomainTypeDef#

# TargetDomainTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import TargetDomainTypeDef


def get_value() -> TargetDomainTypeDef:
    return {
        "targetDomainId": ...,
    }


# TargetDomainTypeDef definition

class TargetDomainTypeDef(TypedDict):
    targetDomainId: str,
    domainName: str,
    verificationStatus: NotRequired[TargetDomainStatusType],  # (1)
    verificationDetails: NotRequired[VerificationDetailsTypeDef],  # (2)
    createdAt: NotRequired[datetime.datetime],
    verifiedAt: NotRequired[datetime.datetime],
  1. See TargetDomainStatusType
  2. See VerificationDetailsTypeDef

UpdateTargetDomainOutputTypeDef#

# UpdateTargetDomainOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateTargetDomainOutputTypeDef


def get_value() -> UpdateTargetDomainOutputTypeDef:
    return {
        "targetDomainId": ...,
    }


# UpdateTargetDomainOutputTypeDef definition

class UpdateTargetDomainOutputTypeDef(TypedDict):
    targetDomainId: str,
    domainName: str,
    verificationStatus: TargetDomainStatusType,  # (1)
    verificationDetails: VerificationDetailsTypeDef,  # (2)
    createdAt: datetime.datetime,
    verifiedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TargetDomainStatusType
  2. See VerificationDetailsTypeDef
  3. See ResponseMetadataTypeDef

CreateMembershipRequestTypeDef#

# CreateMembershipRequestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateMembershipRequestTypeDef


def get_value() -> CreateMembershipRequestTypeDef:
    return {
        "applicationId": ...,
    }


# CreateMembershipRequestTypeDef definition

class CreateMembershipRequestTypeDef(TypedDict):
    applicationId: str,
    agentSpaceId: str,
    membershipId: str,
    memberType: MembershipTypeType,  # (1)
    config: NotRequired[MembershipConfigTypeDef],  # (2)
  1. See MembershipTypeType
  2. See MembershipConfigTypeDef

MembershipSummaryTypeDef#

# MembershipSummaryTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import MembershipSummaryTypeDef


def get_value() -> MembershipSummaryTypeDef:
    return {
        "membershipId": ...,
    }


# MembershipSummaryTypeDef definition

class MembershipSummaryTypeDef(TypedDict):
    membershipId: str,
    applicationId: str,
    agentSpaceId: str,
    memberType: MembershipTypeType,  # (1)
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    createdBy: str,
    updatedBy: str,
    config: NotRequired[MembershipConfigTypeDef],  # (2)
    metadata: NotRequired[MemberMetadataTypeDef],  # (3)
  1. See MembershipTypeType
  2. See MembershipConfigTypeDef
  3. See MemberMetadataTypeDef

PentestJobTypeDef#

# PentestJobTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import PentestJobTypeDef


def get_value() -> PentestJobTypeDef:
    return {
        "pentestJobId": ...,
    }


# PentestJobTypeDef definition

class PentestJobTypeDef(TypedDict):
    pentestJobId: NotRequired[str],
    pentestId: NotRequired[str],
    title: NotRequired[str],
    overview: NotRequired[str],
    status: NotRequired[JobStatusType],  # (1)
    endpoints: NotRequired[list[EndpointTypeDef]],  # (2)
    actors: NotRequired[list[ActorOutputTypeDef]],  # (3)
    documents: NotRequired[list[DocumentInfoTypeDef]],  # (4)
    sourceCode: NotRequired[list[SourceCodeRepositoryTypeDef]],  # (5)
    excludePaths: NotRequired[list[EndpointTypeDef]],  # (2)
    allowedDomains: NotRequired[list[EndpointTypeDef]],  # (2)
    excludeRiskTypes: NotRequired[list[RiskTypeType]],  # (8)
    steps: NotRequired[list[StepTypeDef]],  # (9)
    executionContext: NotRequired[list[ExecutionContextTypeDef]],  # (10)
    serviceRole: NotRequired[str],
    logConfig: NotRequired[CloudWatchLogTypeDef],  # (11)
    vpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (12)
    networkTrafficConfig: NotRequired[NetworkTrafficConfigOutputTypeDef],  # (13)
    errorInformation: NotRequired[ErrorInformationTypeDef],  # (14)
    integratedRepositories: NotRequired[list[IntegratedRepositoryTypeDef]],  # (15)
    codeRemediationStrategy: NotRequired[CodeRemediationStrategyType],  # (16)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See JobStatusType
  2. See list[EndpointTypeDef]
  3. See list[ActorOutputTypeDef]
  4. See list[DocumentInfoTypeDef]
  5. See list[SourceCodeRepositoryTypeDef]
  6. See list[EndpointTypeDef]
  7. See list[EndpointTypeDef]
  8. See list[RiskTypeType]
  9. See list[StepTypeDef]
  10. See list[ExecutionContextTypeDef]
  11. See CloudWatchLogTypeDef
  12. See VpcConfigOutputTypeDef
  13. See NetworkTrafficConfigOutputTypeDef
  14. See ErrorInformationTypeDef
  15. See list[IntegratedRepositoryTypeDef]
  16. See CodeRemediationStrategyType

BatchGetAgentSpacesOutputTypeDef#

# BatchGetAgentSpacesOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetAgentSpacesOutputTypeDef


def get_value() -> BatchGetAgentSpacesOutputTypeDef:
    return {
        "agentSpaces": ...,
    }


# BatchGetAgentSpacesOutputTypeDef definition

class BatchGetAgentSpacesOutputTypeDef(TypedDict):
    agentSpaces: list[AgentSpaceTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[AgentSpaceTypeDef]
  2. See ResponseMetadataTypeDef

CreateAgentSpaceInputTypeDef#

# CreateAgentSpaceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreateAgentSpaceInputTypeDef


def get_value() -> CreateAgentSpaceInputTypeDef:
    return {
        "name": ...,
    }


# CreateAgentSpaceInputTypeDef definition

class CreateAgentSpaceInputTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    awsResources: NotRequired[AWSResourcesUnionTypeDef],  # (1)
    targetDomainIds: NotRequired[Sequence[str]],
    codeReviewSettings: NotRequired[CodeReviewSettingsTypeDef],  # (2)
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AWSResourcesUnionTypeDef
  2. See CodeReviewSettingsTypeDef

UpdateAgentSpaceInputTypeDef#

# UpdateAgentSpaceInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateAgentSpaceInputTypeDef


def get_value() -> UpdateAgentSpaceInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# UpdateAgentSpaceInputTypeDef definition

class UpdateAgentSpaceInputTypeDef(TypedDict):
    agentSpaceId: str,
    name: NotRequired[str],
    description: NotRequired[str],
    awsResources: NotRequired[AWSResourcesUnionTypeDef],  # (1)
    targetDomainIds: NotRequired[Sequence[str]],
    codeReviewSettings: NotRequired[CodeReviewSettingsTypeDef],  # (2)
  1. See AWSResourcesUnionTypeDef
  2. See CodeReviewSettingsTypeDef

CreatePentestOutputTypeDef#

# CreatePentestOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreatePentestOutputTypeDef


def get_value() -> CreatePentestOutputTypeDef:
    return {
        "pentestId": ...,
    }


# CreatePentestOutputTypeDef definition

class CreatePentestOutputTypeDef(TypedDict):
    pentestId: str,
    title: str,
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    assets: AssetsOutputTypeDef,  # (1)
    excludeRiskTypes: list[RiskTypeType],  # (2)
    serviceRole: str,
    logConfig: CloudWatchLogTypeDef,  # (3)
    agentSpaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AssetsOutputTypeDef
  2. See list[RiskTypeType]
  3. See CloudWatchLogTypeDef
  4. See ResponseMetadataTypeDef

PentestTypeDef#

# PentestTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import PentestTypeDef


def get_value() -> PentestTypeDef:
    return {
        "pentestId": ...,
    }


# PentestTypeDef definition

class PentestTypeDef(TypedDict):
    pentestId: str,
    agentSpaceId: str,
    title: str,
    assets: AssetsOutputTypeDef,  # (1)
    excludeRiskTypes: NotRequired[list[RiskTypeType]],  # (2)
    serviceRole: NotRequired[str],
    logConfig: NotRequired[CloudWatchLogTypeDef],  # (3)
    vpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (4)
    networkTrafficConfig: NotRequired[NetworkTrafficConfigOutputTypeDef],  # (5)
    codeRemediationStrategy: NotRequired[CodeRemediationStrategyType],  # (6)
    createdAt: NotRequired[datetime.datetime],
    updatedAt: NotRequired[datetime.datetime],
  1. See AssetsOutputTypeDef
  2. See list[RiskTypeType]
  3. See CloudWatchLogTypeDef
  4. See VpcConfigOutputTypeDef
  5. See NetworkTrafficConfigOutputTypeDef
  6. See CodeRemediationStrategyType

UpdatePentestOutputTypeDef#

# UpdatePentestOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdatePentestOutputTypeDef


def get_value() -> UpdatePentestOutputTypeDef:
    return {
        "pentestId": ...,
    }


# UpdatePentestOutputTypeDef definition

class UpdatePentestOutputTypeDef(TypedDict):
    pentestId: str,
    title: str,
    createdAt: datetime.datetime,
    updatedAt: datetime.datetime,
    assets: AssetsOutputTypeDef,  # (1)
    excludeRiskTypes: list[RiskTypeType],  # (2)
    serviceRole: str,
    logConfig: CloudWatchLogTypeDef,  # (3)
    agentSpaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AssetsOutputTypeDef
  2. See list[RiskTypeType]
  3. See CloudWatchLogTypeDef
  4. See ResponseMetadataTypeDef

BatchGetPentestJobTasksOutputTypeDef#

# BatchGetPentestJobTasksOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestJobTasksOutputTypeDef


def get_value() -> BatchGetPentestJobTasksOutputTypeDef:
    return {
        "tasks": ...,
    }


# BatchGetPentestJobTasksOutputTypeDef definition

class BatchGetPentestJobTasksOutputTypeDef(TypedDict):
    tasks: list[TaskTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[TaskTypeDef]
  2. See ResponseMetadataTypeDef

BatchGetFindingsOutputTypeDef#

# BatchGetFindingsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetFindingsOutputTypeDef


def get_value() -> BatchGetFindingsOutputTypeDef:
    return {
        "findings": ...,
    }


# BatchGetFindingsOutputTypeDef definition

class BatchGetFindingsOutputTypeDef(TypedDict):
    findings: list[FindingTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[FindingTypeDef]
  2. See ResponseMetadataTypeDef

UpdateIntegratedResourcesInputTypeDef#

# UpdateIntegratedResourcesInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdateIntegratedResourcesInputTypeDef


def get_value() -> UpdateIntegratedResourcesInputTypeDef:
    return {
        "agentSpaceId": ...,
    }


# UpdateIntegratedResourcesInputTypeDef definition

class UpdateIntegratedResourcesInputTypeDef(TypedDict):
    agentSpaceId: str,
    integrationId: str,
    items: Sequence[IntegratedResourceInputItemTypeDef],  # (1)
  1. See Sequence[IntegratedResourceInputItemTypeDef]

ListIntegratedResourcesOutputTypeDef#

# ListIntegratedResourcesOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListIntegratedResourcesOutputTypeDef


def get_value() -> ListIntegratedResourcesOutputTypeDef:
    return {
        "integratedResourceSummaries": ...,
    }


# ListIntegratedResourcesOutputTypeDef definition

class ListIntegratedResourcesOutputTypeDef(TypedDict):
    integratedResourceSummaries: list[IntegratedResourceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[IntegratedResourceSummaryTypeDef]
  2. See ResponseMetadataTypeDef

BatchGetTargetDomainsOutputTypeDef#

# BatchGetTargetDomainsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetTargetDomainsOutputTypeDef


def get_value() -> BatchGetTargetDomainsOutputTypeDef:
    return {
        "targetDomains": ...,
    }


# BatchGetTargetDomainsOutputTypeDef definition

class BatchGetTargetDomainsOutputTypeDef(TypedDict):
    targetDomains: list[TargetDomainTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[TargetDomainTypeDef]
  2. See ResponseMetadataTypeDef

ListMembershipsResponseTypeDef#

# ListMembershipsResponseTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import ListMembershipsResponseTypeDef


def get_value() -> ListMembershipsResponseTypeDef:
    return {
        "membershipSummaries": ...,
    }


# ListMembershipsResponseTypeDef definition

class ListMembershipsResponseTypeDef(TypedDict):
    membershipSummaries: list[MembershipSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[MembershipSummaryTypeDef]
  2. See ResponseMetadataTypeDef

BatchGetPentestJobsOutputTypeDef#

# BatchGetPentestJobsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestJobsOutputTypeDef


def get_value() -> BatchGetPentestJobsOutputTypeDef:
    return {
        "pentestJobs": ...,
    }


# BatchGetPentestJobsOutputTypeDef definition

class BatchGetPentestJobsOutputTypeDef(TypedDict):
    pentestJobs: list[PentestJobTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[PentestJobTypeDef]
  2. See ResponseMetadataTypeDef

BatchDeletePentestsOutputTypeDef#

# BatchDeletePentestsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchDeletePentestsOutputTypeDef


def get_value() -> BatchDeletePentestsOutputTypeDef:
    return {
        "deleted": ...,
    }


# BatchDeletePentestsOutputTypeDef definition

class BatchDeletePentestsOutputTypeDef(TypedDict):
    deleted: list[PentestTypeDef],  # (1)
    failed: list[DeletePentestFailureTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See list[PentestTypeDef]
  2. See list[DeletePentestFailureTypeDef]
  3. See ResponseMetadataTypeDef

BatchGetPentestsOutputTypeDef#

# BatchGetPentestsOutputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import BatchGetPentestsOutputTypeDef


def get_value() -> BatchGetPentestsOutputTypeDef:
    return {
        "pentests": ...,
    }


# BatchGetPentestsOutputTypeDef definition

class BatchGetPentestsOutputTypeDef(TypedDict):
    pentests: list[PentestTypeDef],  # (1)
    notFound: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See list[PentestTypeDef]
  2. See ResponseMetadataTypeDef

CreatePentestInputTypeDef#

# CreatePentestInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import CreatePentestInputTypeDef


def get_value() -> CreatePentestInputTypeDef:
    return {
        "title": ...,
    }


# CreatePentestInputTypeDef definition

class CreatePentestInputTypeDef(TypedDict):
    title: str,
    agentSpaceId: str,
    assets: NotRequired[AssetsUnionTypeDef],  # (1)
    excludeRiskTypes: NotRequired[Sequence[RiskTypeType]],  # (2)
    serviceRole: NotRequired[str],
    logConfig: NotRequired[CloudWatchLogTypeDef],  # (3)
    vpcConfig: NotRequired[VpcConfigUnionTypeDef],  # (4)
    networkTrafficConfig: NotRequired[NetworkTrafficConfigUnionTypeDef],  # (5)
    codeRemediationStrategy: NotRequired[CodeRemediationStrategyType],  # (6)
  1. See AssetsUnionTypeDef
  2. See Sequence[RiskTypeType]
  3. See CloudWatchLogTypeDef
  4. See VpcConfigUnionTypeDef
  5. See NetworkTrafficConfigUnionTypeDef
  6. See CodeRemediationStrategyType

UpdatePentestInputTypeDef#

# UpdatePentestInputTypeDef TypedDict usage example

from types_boto3_securityagent.type_defs import UpdatePentestInputTypeDef


def get_value() -> UpdatePentestInputTypeDef:
    return {
        "pentestId": ...,
    }


# UpdatePentestInputTypeDef definition

class UpdatePentestInputTypeDef(TypedDict):
    pentestId: str,
    agentSpaceId: str,
    title: NotRequired[str],
    assets: NotRequired[AssetsUnionTypeDef],  # (1)
    excludeRiskTypes: NotRequired[Sequence[RiskTypeType]],  # (2)
    serviceRole: NotRequired[str],
    logConfig: NotRequired[CloudWatchLogTypeDef],  # (3)
    vpcConfig: NotRequired[VpcConfigUnionTypeDef],  # (4)
    networkTrafficConfig: NotRequired[NetworkTrafficConfigUnionTypeDef],  # (5)
    codeRemediationStrategy: NotRequired[CodeRemediationStrategyType],  # (6)
  1. See AssetsUnionTypeDef
  2. See Sequence[RiskTypeType]
  3. See CloudWatchLogTypeDef
  4. See VpcConfigUnionTypeDef
  5. See NetworkTrafficConfigUnionTypeDef
  6. See CodeRemediationStrategyType