Skip to content

Type definitions#

Index > Inspector > Type definitions

Auto-generated documentation for Inspector type annotations stubs module types-aiobotocore-inspector.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

FailedItemDetailsTypeDef#

# FailedItemDetailsTypeDef definition

class FailedItemDetailsTypeDef(TypedDict):
    failureCode: FailedItemErrorCodeType,  # (1)
    retryable: bool,
  1. See FailedItemErrorCodeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AgentFilterTypeDef#

# AgentFilterTypeDef definition

class AgentFilterTypeDef(TypedDict):
    agentHealths: Sequence[AgentHealthType],  # (1)
    agentHealthCodes: Sequence[AgentHealthCodeType],  # (2)
  1. See AgentHealthType
  2. See AgentHealthCodeType

AgentPreviewTypeDef#

# AgentPreviewTypeDef definition

class AgentPreviewTypeDef(TypedDict):
    agentId: str,
    hostname: NotRequired[str],
    autoScalingGroup: NotRequired[str],
    agentHealth: NotRequired[AgentHealthType],  # (1)
    agentVersion: NotRequired[str],
    operatingSystem: NotRequired[str],
    kernelVersion: NotRequired[str],
    ipv4Address: NotRequired[str],
  1. See AgentHealthType

TelemetryMetadataTypeDef#

# TelemetryMetadataTypeDef definition

class TelemetryMetadataTypeDef(TypedDict):
    messageType: str,
    count: int,
    dataSize: NotRequired[int],

DurationRangeTypeDef#

# DurationRangeTypeDef definition

class DurationRangeTypeDef(TypedDict):
    minSeconds: NotRequired[int],
    maxSeconds: NotRequired[int],

AssessmentRunNotificationTypeDef#

# AssessmentRunNotificationTypeDef definition

class AssessmentRunNotificationTypeDef(TypedDict):
    date: datetime,
    event: InspectorEventType,  # (1)
    error: bool,
    message: NotRequired[str],
    snsTopicArn: NotRequired[str],
    snsPublishStatusCode: NotRequired[AssessmentRunNotificationSnsStatusCodeType],  # (2)
  1. See InspectorEventType
  2. See AssessmentRunNotificationSnsStatusCodeType

AssessmentRunStateChangeTypeDef#

# AssessmentRunStateChangeTypeDef definition

class AssessmentRunStateChangeTypeDef(TypedDict):
    stateChangedAt: datetime,
    state: AssessmentRunStateType,  # (1)
  1. See AssessmentRunStateType

AssessmentTargetFilterTypeDef#

# AssessmentTargetFilterTypeDef definition

class AssessmentTargetFilterTypeDef(TypedDict):
    assessmentTargetNamePattern: NotRequired[str],

AssessmentTargetTypeDef#

# AssessmentTargetTypeDef definition

class AssessmentTargetTypeDef(TypedDict):
    arn: str,
    name: str,
    createdAt: datetime,
    updatedAt: datetime,
    resourceGroupArn: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

CreateAssessmentTargetRequestRequestTypeDef#

# CreateAssessmentTargetRequestRequestTypeDef definition

class CreateAssessmentTargetRequestRequestTypeDef(TypedDict):
    assessmentTargetName: str,
    resourceGroupArn: NotRequired[str],

CreateExclusionsPreviewRequestRequestTypeDef#

# CreateExclusionsPreviewRequestRequestTypeDef definition

class CreateExclusionsPreviewRequestRequestTypeDef(TypedDict):
    assessmentTemplateArn: str,

ResourceGroupTagTypeDef#

# ResourceGroupTagTypeDef definition

class ResourceGroupTagTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

DeleteAssessmentRunRequestRequestTypeDef#

# DeleteAssessmentRunRequestRequestTypeDef definition

class DeleteAssessmentRunRequestRequestTypeDef(TypedDict):
    assessmentRunArn: str,

DeleteAssessmentTargetRequestRequestTypeDef#

# DeleteAssessmentTargetRequestRequestTypeDef definition

class DeleteAssessmentTargetRequestRequestTypeDef(TypedDict):
    assessmentTargetArn: str,

DeleteAssessmentTemplateRequestRequestTypeDef#

# DeleteAssessmentTemplateRequestRequestTypeDef definition

class DeleteAssessmentTemplateRequestRequestTypeDef(TypedDict):
    assessmentTemplateArn: str,

DescribeAssessmentRunsRequestRequestTypeDef#

# DescribeAssessmentRunsRequestRequestTypeDef definition

class DescribeAssessmentRunsRequestRequestTypeDef(TypedDict):
    assessmentRunArns: Sequence[str],

DescribeAssessmentTargetsRequestRequestTypeDef#

# DescribeAssessmentTargetsRequestRequestTypeDef definition

class DescribeAssessmentTargetsRequestRequestTypeDef(TypedDict):
    assessmentTargetArns: Sequence[str],

DescribeAssessmentTemplatesRequestRequestTypeDef#

# DescribeAssessmentTemplatesRequestRequestTypeDef definition

class DescribeAssessmentTemplatesRequestRequestTypeDef(TypedDict):
    assessmentTemplateArns: Sequence[str],

DescribeExclusionsRequestRequestTypeDef#

# DescribeExclusionsRequestRequestTypeDef definition

class DescribeExclusionsRequestRequestTypeDef(TypedDict):
    exclusionArns: Sequence[str],
    locale: NotRequired[LocaleType],  # (1)
  1. See LocaleType

DescribeFindingsRequestRequestTypeDef#

# DescribeFindingsRequestRequestTypeDef definition

class DescribeFindingsRequestRequestTypeDef(TypedDict):
    findingArns: Sequence[str],
    locale: NotRequired[LocaleType],  # (1)
  1. See LocaleType

DescribeResourceGroupsRequestRequestTypeDef#

# DescribeResourceGroupsRequestRequestTypeDef definition

class DescribeResourceGroupsRequestRequestTypeDef(TypedDict):
    resourceGroupArns: Sequence[str],

DescribeRulesPackagesRequestRequestTypeDef#

# DescribeRulesPackagesRequestRequestTypeDef definition

class DescribeRulesPackagesRequestRequestTypeDef(TypedDict):
    rulesPackageArns: Sequence[str],
    locale: NotRequired[LocaleType],  # (1)
  1. See LocaleType

RulesPackageTypeDef#

# RulesPackageTypeDef definition

class RulesPackageTypeDef(TypedDict):
    arn: str,
    name: str,
    version: str,
    provider: str,
    description: NotRequired[str],

EventSubscriptionTypeDef#

# EventSubscriptionTypeDef definition

class EventSubscriptionTypeDef(TypedDict):
    event: InspectorEventType,  # (1)
    subscribedAt: datetime,
  1. See InspectorEventType

ScopeTypeDef#

# ScopeTypeDef definition

class ScopeTypeDef(TypedDict):
    key: NotRequired[ScopeTypeType],  # (1)
    value: NotRequired[str],
  1. See ScopeTypeType

InspectorServiceAttributesTypeDef#

# InspectorServiceAttributesTypeDef definition

class InspectorServiceAttributesTypeDef(TypedDict):
    schemaVersion: int,
    assessmentRunArn: NotRequired[str],
    rulesPackageArn: NotRequired[str],

GetAssessmentReportRequestRequestTypeDef#

# GetAssessmentReportRequestRequestTypeDef definition

class GetAssessmentReportRequestRequestTypeDef(TypedDict):
    assessmentRunArn: str,
    reportFileFormat: ReportFileFormatType,  # (1)
    reportType: ReportTypeType,  # (2)
  1. See ReportFileFormatType
  2. See ReportTypeType

GetExclusionsPreviewRequestRequestTypeDef#

# GetExclusionsPreviewRequestRequestTypeDef definition

class GetExclusionsPreviewRequestRequestTypeDef(TypedDict):
    assessmentTemplateArn: str,
    previewToken: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    locale: NotRequired[LocaleType],  # (1)
  1. See LocaleType

GetTelemetryMetadataRequestRequestTypeDef#

# GetTelemetryMetadataRequestRequestTypeDef definition

class GetTelemetryMetadataRequestRequestTypeDef(TypedDict):
    assessmentRunArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListEventSubscriptionsRequestRequestTypeDef#

# ListEventSubscriptionsRequestRequestTypeDef definition

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

ListExclusionsRequestRequestTypeDef#

# ListExclusionsRequestRequestTypeDef definition

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

ListRulesPackagesRequestRequestTypeDef#

# ListRulesPackagesRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

PrivateIpTypeDef#

# PrivateIpTypeDef definition

class PrivateIpTypeDef(TypedDict):
    privateDnsName: NotRequired[str],
    privateIpAddress: NotRequired[str],

SecurityGroupTypeDef#

# SecurityGroupTypeDef definition

class SecurityGroupTypeDef(TypedDict):
    groupName: NotRequired[str],
    groupId: NotRequired[str],

PreviewAgentsRequestRequestTypeDef#

# PreviewAgentsRequestRequestTypeDef definition

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

RegisterCrossAccountAccessRoleRequestRequestTypeDef#

# RegisterCrossAccountAccessRoleRequestRequestTypeDef definition

class RegisterCrossAccountAccessRoleRequestRequestTypeDef(TypedDict):
    roleArn: str,

RemoveAttributesFromFindingsRequestRequestTypeDef#

# RemoveAttributesFromFindingsRequestRequestTypeDef definition

class RemoveAttributesFromFindingsRequestRequestTypeDef(TypedDict):
    findingArns: Sequence[str],
    attributeKeys: Sequence[str],

StartAssessmentRunRequestRequestTypeDef#

# StartAssessmentRunRequestRequestTypeDef definition

class StartAssessmentRunRequestRequestTypeDef(TypedDict):
    assessmentTemplateArn: str,
    assessmentRunName: NotRequired[str],

StopAssessmentRunRequestRequestTypeDef#

# StopAssessmentRunRequestRequestTypeDef definition

class StopAssessmentRunRequestRequestTypeDef(TypedDict):
    assessmentRunArn: str,
    stopAction: NotRequired[StopActionType],  # (1)
  1. See StopActionType

SubscribeToEventRequestRequestTypeDef#

# SubscribeToEventRequestRequestTypeDef definition

class SubscribeToEventRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    event: InspectorEventType,  # (1)
    topicArn: str,
  1. See InspectorEventType

UnsubscribeFromEventRequestRequestTypeDef#

# UnsubscribeFromEventRequestRequestTypeDef definition

class UnsubscribeFromEventRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    event: InspectorEventType,  # (1)
    topicArn: str,
  1. See InspectorEventType

UpdateAssessmentTargetRequestRequestTypeDef#

# UpdateAssessmentTargetRequestRequestTypeDef definition

class UpdateAssessmentTargetRequestRequestTypeDef(TypedDict):
    assessmentTargetArn: str,
    assessmentTargetName: str,
    resourceGroupArn: NotRequired[str],

AddAttributesToFindingsRequestRequestTypeDef#

# AddAttributesToFindingsRequestRequestTypeDef definition

class AddAttributesToFindingsRequestRequestTypeDef(TypedDict):
    findingArns: Sequence[str],
    attributes: Sequence[AttributeTypeDef],  # (1)
  1. See AttributeTypeDef

AssessmentTemplateTypeDef#

# AssessmentTemplateTypeDef definition

class AssessmentTemplateTypeDef(TypedDict):
    arn: str,
    name: str,
    assessmentTargetArn: str,
    durationInSeconds: int,
    rulesPackageArns: List[str],
    userAttributesForFindings: List[AttributeTypeDef],  # (1)
    assessmentRunCount: int,
    createdAt: datetime,
    lastAssessmentRunArn: NotRequired[str],
  1. See AttributeTypeDef

CreateAssessmentTemplateRequestRequestTypeDef#

# CreateAssessmentTemplateRequestRequestTypeDef definition

class CreateAssessmentTemplateRequestRequestTypeDef(TypedDict):
    assessmentTargetArn: str,
    assessmentTemplateName: str,
    durationInSeconds: int,
    rulesPackageArns: Sequence[str],
    userAttributesForFindings: NotRequired[Sequence[AttributeTypeDef]],  # (1)
  1. See AttributeTypeDef

AddAttributesToFindingsResponseTypeDef#

# AddAttributesToFindingsResponseTypeDef definition

class AddAttributesToFindingsResponseTypeDef(TypedDict):
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedItemDetailsTypeDef
  2. See ResponseMetadataTypeDef

CreateAssessmentTargetResponseTypeDef#

# CreateAssessmentTargetResponseTypeDef definition

class CreateAssessmentTargetResponseTypeDef(TypedDict):
    assessmentTargetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAssessmentTemplateResponseTypeDef#

# CreateAssessmentTemplateResponseTypeDef definition

class CreateAssessmentTemplateResponseTypeDef(TypedDict):
    assessmentTemplateArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateExclusionsPreviewResponseTypeDef#

# CreateExclusionsPreviewResponseTypeDef definition

class CreateExclusionsPreviewResponseTypeDef(TypedDict):
    previewToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateResourceGroupResponseTypeDef#

# CreateResourceGroupResponseTypeDef definition

class CreateResourceGroupResponseTypeDef(TypedDict):
    resourceGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeCrossAccountAccessRoleResponseTypeDef#

# DescribeCrossAccountAccessRoleResponseTypeDef definition

class DescribeCrossAccountAccessRoleResponseTypeDef(TypedDict):
    roleArn: str,
    valid: bool,
    registeredAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetAssessmentReportResponseTypeDef#

# GetAssessmentReportResponseTypeDef definition

class GetAssessmentReportResponseTypeDef(TypedDict):
    status: ReportStatusType,  # (1)
    url: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReportStatusType
  2. See ResponseMetadataTypeDef

ListAssessmentRunsResponseTypeDef#

# ListAssessmentRunsResponseTypeDef definition

class ListAssessmentRunsResponseTypeDef(TypedDict):
    assessmentRunArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAssessmentTargetsResponseTypeDef#

# ListAssessmentTargetsResponseTypeDef definition

class ListAssessmentTargetsResponseTypeDef(TypedDict):
    assessmentTargetArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAssessmentTemplatesResponseTypeDef#

# ListAssessmentTemplatesResponseTypeDef definition

class ListAssessmentTemplatesResponseTypeDef(TypedDict):
    assessmentTemplateArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListExclusionsResponseTypeDef#

# ListExclusionsResponseTypeDef definition

class ListExclusionsResponseTypeDef(TypedDict):
    exclusionArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListFindingsResponseTypeDef#

# ListFindingsResponseTypeDef definition

class ListFindingsResponseTypeDef(TypedDict):
    findingArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListRulesPackagesResponseTypeDef#

# ListRulesPackagesResponseTypeDef definition

class ListRulesPackagesResponseTypeDef(TypedDict):
    rulesPackageArns: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveAttributesFromFindingsResponseTypeDef#

# RemoveAttributesFromFindingsResponseTypeDef definition

class RemoveAttributesFromFindingsResponseTypeDef(TypedDict):
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedItemDetailsTypeDef
  2. See ResponseMetadataTypeDef

StartAssessmentRunResponseTypeDef#

# StartAssessmentRunResponseTypeDef definition

class StartAssessmentRunResponseTypeDef(TypedDict):
    assessmentRunArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAssessmentRunAgentsRequestRequestTypeDef#

# ListAssessmentRunAgentsRequestRequestTypeDef definition

class ListAssessmentRunAgentsRequestRequestTypeDef(TypedDict):
    assessmentRunArn: str,
    filter: NotRequired[AgentFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See AgentFilterTypeDef

PreviewAgentsResponseTypeDef#

# PreviewAgentsResponseTypeDef definition

class PreviewAgentsResponseTypeDef(TypedDict):
    agentPreviews: List[AgentPreviewTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentPreviewTypeDef
  2. See ResponseMetadataTypeDef

AssessmentRunAgentTypeDef#

# AssessmentRunAgentTypeDef definition

class AssessmentRunAgentTypeDef(TypedDict):
    agentId: str,
    assessmentRunArn: str,
    agentHealth: AgentHealthType,  # (1)
    agentHealthCode: AgentHealthCodeType,  # (2)
    telemetryMetadata: List[TelemetryMetadataTypeDef],  # (3)
    agentHealthDetails: NotRequired[str],
    autoScalingGroup: NotRequired[str],
  1. See AgentHealthType
  2. See AgentHealthCodeType
  3. See TelemetryMetadataTypeDef

GetTelemetryMetadataResponseTypeDef#

# GetTelemetryMetadataResponseTypeDef definition

class GetTelemetryMetadataResponseTypeDef(TypedDict):
    telemetryMetadata: List[TelemetryMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TelemetryMetadataTypeDef
  2. See ResponseMetadataTypeDef

AssessmentTemplateFilterTypeDef#

# AssessmentTemplateFilterTypeDef definition

class AssessmentTemplateFilterTypeDef(TypedDict):
    namePattern: NotRequired[str],
    durationRange: NotRequired[DurationRangeTypeDef],  # (1)
    rulesPackageArns: NotRequired[Sequence[str]],
  1. See DurationRangeTypeDef

AssessmentRunTypeDef#

# AssessmentRunTypeDef definition

class AssessmentRunTypeDef(TypedDict):
    arn: str,
    name: str,
    assessmentTemplateArn: str,
    state: AssessmentRunStateType,  # (1)
    durationInSeconds: int,
    rulesPackageArns: List[str],
    userAttributesForFindings: List[AttributeTypeDef],  # (2)
    createdAt: datetime,
    stateChangedAt: datetime,
    dataCollected: bool,
    stateChanges: List[AssessmentRunStateChangeTypeDef],  # (3)
    notifications: List[AssessmentRunNotificationTypeDef],  # (4)
    findingCounts: Dict[SeverityType, int],  # (5)
    startedAt: NotRequired[datetime],
    completedAt: NotRequired[datetime],
  1. See AssessmentRunStateType
  2. See AttributeTypeDef
  3. See AssessmentRunStateChangeTypeDef
  4. See AssessmentRunNotificationTypeDef
  5. See SeverityType

ListAssessmentTargetsRequestRequestTypeDef#

# ListAssessmentTargetsRequestRequestTypeDef definition

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

DescribeAssessmentTargetsResponseTypeDef#

# DescribeAssessmentTargetsResponseTypeDef definition

class DescribeAssessmentTargetsResponseTypeDef(TypedDict):
    assessmentTargets: List[AssessmentTargetTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssessmentTargetTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

SetTagsForResourceRequestRequestTypeDef#

# SetTagsForResourceRequestRequestTypeDef definition

class SetTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateResourceGroupRequestRequestTypeDef#

# CreateResourceGroupRequestRequestTypeDef definition

class CreateResourceGroupRequestRequestTypeDef(TypedDict):
    resourceGroupTags: Sequence[ResourceGroupTagTypeDef],  # (1)
  1. See ResourceGroupTagTypeDef

ResourceGroupTypeDef#

# ResourceGroupTypeDef definition

class ResourceGroupTypeDef(TypedDict):
    arn: str,
    tags: List[ResourceGroupTagTypeDef],  # (1)
    createdAt: datetime,
  1. See ResourceGroupTagTypeDef

DescribeRulesPackagesResponseTypeDef#

# DescribeRulesPackagesResponseTypeDef definition

class DescribeRulesPackagesResponseTypeDef(TypedDict):
    rulesPackages: List[RulesPackageTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RulesPackageTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

SubscriptionTypeDef#

# SubscriptionTypeDef definition

class SubscriptionTypeDef(TypedDict):
    resourceArn: str,
    topicArn: str,
    eventSubscriptions: List[EventSubscriptionTypeDef],  # (1)
  1. See EventSubscriptionTypeDef

ExclusionPreviewTypeDef#

# ExclusionPreviewTypeDef definition

class ExclusionPreviewTypeDef(TypedDict):
    title: str,
    description: str,
    recommendation: str,
    scopes: List[ScopeTypeDef],  # (1)
    attributes: NotRequired[List[AttributeTypeDef]],  # (2)
  1. See ScopeTypeDef
  2. See AttributeTypeDef

ExclusionTypeDef#

# ExclusionTypeDef definition

class ExclusionTypeDef(TypedDict):
    arn: str,
    title: str,
    description: str,
    recommendation: str,
    scopes: List[ScopeTypeDef],  # (1)
    attributes: NotRequired[List[AttributeTypeDef]],  # (2)
  1. See ScopeTypeDef
  2. See AttributeTypeDef

ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef#

# ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef definition

class ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef(TypedDict):
    assessmentRunArn: str,
    filter: NotRequired[AgentFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See AgentFilterTypeDef
  2. See PaginatorConfigTypeDef

ListAssessmentTargetsRequestListAssessmentTargetsPaginateTypeDef#

# ListAssessmentTargetsRequestListAssessmentTargetsPaginateTypeDef definition

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

ListEventSubscriptionsRequestListEventSubscriptionsPaginateTypeDef#

# ListEventSubscriptionsRequestListEventSubscriptionsPaginateTypeDef definition

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

ListExclusionsRequestListExclusionsPaginateTypeDef#

# ListExclusionsRequestListExclusionsPaginateTypeDef definition

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

ListRulesPackagesRequestListRulesPackagesPaginateTypeDef#

# ListRulesPackagesRequestListRulesPackagesPaginateTypeDef definition

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

PreviewAgentsRequestPreviewAgentsPaginateTypeDef#

# PreviewAgentsRequestPreviewAgentsPaginateTypeDef definition

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

NetworkInterfaceTypeDef#

# NetworkInterfaceTypeDef definition

class NetworkInterfaceTypeDef(TypedDict):
    networkInterfaceId: NotRequired[str],
    subnetId: NotRequired[str],
    vpcId: NotRequired[str],
    privateDnsName: NotRequired[str],
    privateIpAddress: NotRequired[str],
    privateIpAddresses: NotRequired[List[PrivateIpTypeDef]],  # (1)
    publicDnsName: NotRequired[str],
    publicIp: NotRequired[str],
    ipv6Addresses: NotRequired[List[str]],
    securityGroups: NotRequired[List[SecurityGroupTypeDef]],  # (2)
  1. See PrivateIpTypeDef
  2. See SecurityGroupTypeDef

TimestampRangeTypeDef#

# TimestampRangeTypeDef definition

class TimestampRangeTypeDef(TypedDict):
    beginDate: NotRequired[Union[datetime, str]],
    endDate: NotRequired[Union[datetime, str]],

DescribeAssessmentTemplatesResponseTypeDef#

# DescribeAssessmentTemplatesResponseTypeDef definition

class DescribeAssessmentTemplatesResponseTypeDef(TypedDict):
    assessmentTemplates: List[AssessmentTemplateTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssessmentTemplateTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

ListAssessmentRunAgentsResponseTypeDef#

# ListAssessmentRunAgentsResponseTypeDef definition

class ListAssessmentRunAgentsResponseTypeDef(TypedDict):
    assessmentRunAgents: List[AssessmentRunAgentTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentRunAgentTypeDef
  2. See ResponseMetadataTypeDef

ListAssessmentTemplatesRequestListAssessmentTemplatesPaginateTypeDef#

# ListAssessmentTemplatesRequestListAssessmentTemplatesPaginateTypeDef definition

class ListAssessmentTemplatesRequestListAssessmentTemplatesPaginateTypeDef(TypedDict):
    assessmentTargetArns: NotRequired[Sequence[str]],
    filter: NotRequired[AssessmentTemplateFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See AssessmentTemplateFilterTypeDef
  2. See PaginatorConfigTypeDef

ListAssessmentTemplatesRequestRequestTypeDef#

# ListAssessmentTemplatesRequestRequestTypeDef definition

class ListAssessmentTemplatesRequestRequestTypeDef(TypedDict):
    assessmentTargetArns: NotRequired[Sequence[str]],
    filter: NotRequired[AssessmentTemplateFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See AssessmentTemplateFilterTypeDef

DescribeAssessmentRunsResponseTypeDef#

# DescribeAssessmentRunsResponseTypeDef definition

class DescribeAssessmentRunsResponseTypeDef(TypedDict):
    assessmentRuns: List[AssessmentRunTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssessmentRunTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

DescribeResourceGroupsResponseTypeDef#

# DescribeResourceGroupsResponseTypeDef definition

class DescribeResourceGroupsResponseTypeDef(TypedDict):
    resourceGroups: List[ResourceGroupTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ResourceGroupTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

ListEventSubscriptionsResponseTypeDef#

# ListEventSubscriptionsResponseTypeDef definition

class ListEventSubscriptionsResponseTypeDef(TypedDict):
    subscriptions: List[SubscriptionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef

GetExclusionsPreviewResponseTypeDef#

# GetExclusionsPreviewResponseTypeDef definition

class GetExclusionsPreviewResponseTypeDef(TypedDict):
    previewStatus: PreviewStatusType,  # (1)
    exclusionPreviews: List[ExclusionPreviewTypeDef],  # (2)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PreviewStatusType
  2. See ExclusionPreviewTypeDef
  3. See ResponseMetadataTypeDef

DescribeExclusionsResponseTypeDef#

# DescribeExclusionsResponseTypeDef definition

class DescribeExclusionsResponseTypeDef(TypedDict):
    exclusions: Dict[str, ExclusionTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ExclusionTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef

AssetAttributesTypeDef#

# AssetAttributesTypeDef definition

class AssetAttributesTypeDef(TypedDict):
    schemaVersion: int,
    agentId: NotRequired[str],
    autoScalingGroup: NotRequired[str],
    amiId: NotRequired[str],
    hostname: NotRequired[str],
    ipv4Addresses: NotRequired[List[str]],
    tags: NotRequired[List[TagTypeDef]],  # (1)
    networkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]],  # (2)
  1. See TagTypeDef
  2. See NetworkInterfaceTypeDef

AssessmentRunFilterTypeDef#

# AssessmentRunFilterTypeDef definition

class AssessmentRunFilterTypeDef(TypedDict):
    namePattern: NotRequired[str],
    states: NotRequired[Sequence[AssessmentRunStateType]],  # (1)
    durationRange: NotRequired[DurationRangeTypeDef],  # (2)
    rulesPackageArns: NotRequired[Sequence[str]],
    startTimeRange: NotRequired[TimestampRangeTypeDef],  # (3)
    completionTimeRange: NotRequired[TimestampRangeTypeDef],  # (3)
    stateChangeTimeRange: NotRequired[TimestampRangeTypeDef],  # (3)
  1. See AssessmentRunStateType
  2. See DurationRangeTypeDef
  3. See TimestampRangeTypeDef
  4. See TimestampRangeTypeDef
  5. See TimestampRangeTypeDef

FindingFilterTypeDef#

# FindingFilterTypeDef definition

class FindingFilterTypeDef(TypedDict):
    agentIds: NotRequired[Sequence[str]],
    autoScalingGroups: NotRequired[Sequence[str]],
    ruleNames: NotRequired[Sequence[str]],
    severities: NotRequired[Sequence[SeverityType]],  # (1)
    rulesPackageArns: NotRequired[Sequence[str]],
    attributes: NotRequired[Sequence[AttributeTypeDef]],  # (2)
    userAttributes: NotRequired[Sequence[AttributeTypeDef]],  # (2)
    creationTimeRange: NotRequired[TimestampRangeTypeDef],  # (4)
  1. See SeverityType
  2. See AttributeTypeDef
  3. See AttributeTypeDef
  4. See TimestampRangeTypeDef

FindingTypeDef#

# FindingTypeDef definition

class FindingTypeDef(TypedDict):
    arn: str,
    attributes: List[AttributeTypeDef],  # (5)
    userAttributes: List[AttributeTypeDef],  # (5)
    createdAt: datetime,
    updatedAt: datetime,
    schemaVersion: NotRequired[int],
    service: NotRequired[str],
    serviceAttributes: NotRequired[InspectorServiceAttributesTypeDef],  # (1)
    assetType: NotRequired[AssetTypeType],  # (2)
    assetAttributes: NotRequired[AssetAttributesTypeDef],  # (3)
    id: NotRequired[str],
    title: NotRequired[str],
    description: NotRequired[str],
    recommendation: NotRequired[str],
    severity: NotRequired[SeverityType],  # (4)
    numericSeverity: NotRequired[float],
    confidence: NotRequired[int],
    indicatorOfCompromise: NotRequired[bool],
  1. See InspectorServiceAttributesTypeDef
  2. See AssetTypeType
  3. See AssetAttributesTypeDef
  4. See SeverityType
  5. See AttributeTypeDef
  6. See AttributeTypeDef

ListAssessmentRunsRequestListAssessmentRunsPaginateTypeDef#

# ListAssessmentRunsRequestListAssessmentRunsPaginateTypeDef definition

class ListAssessmentRunsRequestListAssessmentRunsPaginateTypeDef(TypedDict):
    assessmentTemplateArns: NotRequired[Sequence[str]],
    filter: NotRequired[AssessmentRunFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See AssessmentRunFilterTypeDef
  2. See PaginatorConfigTypeDef

ListAssessmentRunsRequestRequestTypeDef#

# ListAssessmentRunsRequestRequestTypeDef definition

class ListAssessmentRunsRequestRequestTypeDef(TypedDict):
    assessmentTemplateArns: NotRequired[Sequence[str]],
    filter: NotRequired[AssessmentRunFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See AssessmentRunFilterTypeDef

ListFindingsRequestListFindingsPaginateTypeDef#

# ListFindingsRequestListFindingsPaginateTypeDef definition

class ListFindingsRequestListFindingsPaginateTypeDef(TypedDict):
    assessmentRunArns: NotRequired[Sequence[str]],
    filter: NotRequired[FindingFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FindingFilterTypeDef
  2. See PaginatorConfigTypeDef

ListFindingsRequestRequestTypeDef#

# ListFindingsRequestRequestTypeDef definition

class ListFindingsRequestRequestTypeDef(TypedDict):
    assessmentRunArns: NotRequired[Sequence[str]],
    filter: NotRequired[FindingFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See FindingFilterTypeDef

DescribeFindingsResponseTypeDef#

# DescribeFindingsResponseTypeDef definition

class DescribeFindingsResponseTypeDef(TypedDict):
    findings: List[FindingTypeDef],  # (1)
    failedItems: Dict[str, FailedItemDetailsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FindingTypeDef
  2. See FailedItemDetailsTypeDef
  3. See ResponseMetadataTypeDef