Skip to content

Type definitions#

Index > Inspector > Type definitions

Auto-generated documentation for Inspector type annotations stubs module mypy-boto3-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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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#