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,
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)
- See AgentHealthType
- 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],
- 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)
AssessmentRunStateChangeTypeDef#
# AssessmentRunStateChangeTypeDef definition
class AssessmentRunStateChangeTypeDef(TypedDict):
stateChangedAt: datetime,
state: AssessmentRunStateType, # (1)
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)
- See LocaleType
DescribeFindingsRequestRequestTypeDef#
# DescribeFindingsRequestRequestTypeDef definition
class DescribeFindingsRequestRequestTypeDef(TypedDict):
findingArns: Sequence[str],
locale: NotRequired[LocaleType], # (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)
- 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,
ScopeTypeDef#
# ScopeTypeDef definition
class ScopeTypeDef(TypedDict):
key: NotRequired[ScopeTypeType], # (1)
value: NotRequired[str],
- 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)
- See ReportFileFormatType
- See ReportTypeType
GetExclusionsPreviewRequestRequestTypeDef#
# GetExclusionsPreviewRequestRequestTypeDef definition
class GetExclusionsPreviewRequestRequestTypeDef(TypedDict):
assessmentTemplateArn: str,
previewToken: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
locale: NotRequired[LocaleType], # (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)
- See StopActionType
SubscribeToEventRequestRequestTypeDef#
# SubscribeToEventRequestRequestTypeDef definition
class SubscribeToEventRequestRequestTypeDef(TypedDict):
resourceArn: str,
event: InspectorEventType, # (1)
topicArn: str,
UnsubscribeFromEventRequestRequestTypeDef#
# UnsubscribeFromEventRequestRequestTypeDef definition
class UnsubscribeFromEventRequestRequestTypeDef(TypedDict):
resourceArn: str,
event: InspectorEventType, # (1)
topicArn: str,
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)
- 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],
- See AttributeTypeDef
CreateAssessmentTemplateRequestRequestTypeDef#
# CreateAssessmentTemplateRequestRequestTypeDef definition
class CreateAssessmentTemplateRequestRequestTypeDef(TypedDict):
assessmentTargetArn: str,
assessmentTemplateName: str,
durationInSeconds: int,
rulesPackageArns: Sequence[str],
userAttributesForFindings: NotRequired[Sequence[AttributeTypeDef]], # (1)
- See AttributeTypeDef
AddAttributesToFindingsResponseTypeDef#
# AddAttributesToFindingsResponseTypeDef definition
class AddAttributesToFindingsResponseTypeDef(TypedDict):
failedItems: Dict[str, FailedItemDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAssessmentTargetResponseTypeDef#
# CreateAssessmentTargetResponseTypeDef definition
class CreateAssessmentTargetResponseTypeDef(TypedDict):
assessmentTargetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAssessmentTemplateResponseTypeDef#
# CreateAssessmentTemplateResponseTypeDef definition
class CreateAssessmentTemplateResponseTypeDef(TypedDict):
assessmentTemplateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateExclusionsPreviewResponseTypeDef#
# CreateExclusionsPreviewResponseTypeDef definition
class CreateExclusionsPreviewResponseTypeDef(TypedDict):
previewToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateResourceGroupResponseTypeDef#
# CreateResourceGroupResponseTypeDef definition
class CreateResourceGroupResponseTypeDef(TypedDict):
resourceGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeCrossAccountAccessRoleResponseTypeDef#
# DescribeCrossAccountAccessRoleResponseTypeDef definition
class DescribeCrossAccountAccessRoleResponseTypeDef(TypedDict):
roleArn: str,
valid: bool,
registeredAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAssessmentReportResponseTypeDef#
# GetAssessmentReportResponseTypeDef definition
class GetAssessmentReportResponseTypeDef(TypedDict):
status: ReportStatusType, # (1)
url: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssessmentRunsResponseTypeDef#
# ListAssessmentRunsResponseTypeDef definition
class ListAssessmentRunsResponseTypeDef(TypedDict):
assessmentRunArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAssessmentTargetsResponseTypeDef#
# ListAssessmentTargetsResponseTypeDef definition
class ListAssessmentTargetsResponseTypeDef(TypedDict):
assessmentTargetArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAssessmentTemplatesResponseTypeDef#
# ListAssessmentTemplatesResponseTypeDef definition
class ListAssessmentTemplatesResponseTypeDef(TypedDict):
assessmentTemplateArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListExclusionsResponseTypeDef#
# ListExclusionsResponseTypeDef definition
class ListExclusionsResponseTypeDef(TypedDict):
exclusionArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListFindingsResponseTypeDef#
# ListFindingsResponseTypeDef definition
class ListFindingsResponseTypeDef(TypedDict):
findingArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListRulesPackagesResponseTypeDef#
# ListRulesPackagesResponseTypeDef definition
class ListRulesPackagesResponseTypeDef(TypedDict):
rulesPackageArns: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RemoveAttributesFromFindingsResponseTypeDef#
# RemoveAttributesFromFindingsResponseTypeDef definition
class RemoveAttributesFromFindingsResponseTypeDef(TypedDict):
failedItems: Dict[str, FailedItemDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartAssessmentRunResponseTypeDef#
# StartAssessmentRunResponseTypeDef definition
class StartAssessmentRunResponseTypeDef(TypedDict):
assessmentRunArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAssessmentRunAgentsRequestRequestTypeDef#
# ListAssessmentRunAgentsRequestRequestTypeDef definition
class ListAssessmentRunAgentsRequestRequestTypeDef(TypedDict):
assessmentRunArn: str,
filter: NotRequired[AgentFilterTypeDef], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
PreviewAgentsResponseTypeDef#
# PreviewAgentsResponseTypeDef definition
class PreviewAgentsResponseTypeDef(TypedDict):
agentPreviews: List[AgentPreviewTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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],
GetTelemetryMetadataResponseTypeDef#
# GetTelemetryMetadataResponseTypeDef definition
class GetTelemetryMetadataResponseTypeDef(TypedDict):
telemetryMetadata: List[TelemetryMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssessmentTemplateFilterTypeDef#
# AssessmentTemplateFilterTypeDef definition
class AssessmentTemplateFilterTypeDef(TypedDict):
namePattern: NotRequired[str],
durationRange: NotRequired[DurationRangeTypeDef], # (1)
rulesPackageArns: NotRequired[Sequence[str]],
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],
- See AssessmentRunStateType
- See AttributeTypeDef
- See AssessmentRunStateChangeTypeDef
- See AssessmentRunNotificationTypeDef
- See SeverityType
ListAssessmentTargetsRequestRequestTypeDef#
# ListAssessmentTargetsRequestRequestTypeDef definition
class ListAssessmentTargetsRequestRequestTypeDef(TypedDict):
filter: NotRequired[AssessmentTargetFilterTypeDef], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
DescribeAssessmentTargetsResponseTypeDef#
# DescribeAssessmentTargetsResponseTypeDef definition
class DescribeAssessmentTargetsResponseTypeDef(TypedDict):
assessmentTargets: List[AssessmentTargetTypeDef], # (1)
failedItems: Dict[str, FailedItemDetailsTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
SetTagsForResourceRequestRequestTypeDef#
# SetTagsForResourceRequestRequestTypeDef definition
class SetTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateResourceGroupRequestRequestTypeDef#
# CreateResourceGroupRequestRequestTypeDef definition
class CreateResourceGroupRequestRequestTypeDef(TypedDict):
resourceGroupTags: Sequence[ResourceGroupTagTypeDef], # (1)
ResourceGroupTypeDef#
# ResourceGroupTypeDef definition
class ResourceGroupTypeDef(TypedDict):
arn: str,
tags: List[ResourceGroupTagTypeDef], # (1)
createdAt: datetime,
DescribeRulesPackagesResponseTypeDef#
# DescribeRulesPackagesResponseTypeDef definition
class DescribeRulesPackagesResponseTypeDef(TypedDict):
rulesPackages: List[RulesPackageTypeDef], # (1)
failedItems: Dict[str, FailedItemDetailsTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SubscriptionTypeDef#
# SubscriptionTypeDef definition
class SubscriptionTypeDef(TypedDict):
resourceArn: str,
topicArn: str,
eventSubscriptions: List[EventSubscriptionTypeDef], # (1)
ExclusionPreviewTypeDef#
# ExclusionPreviewTypeDef definition
class ExclusionPreviewTypeDef(TypedDict):
title: str,
description: str,
recommendation: str,
scopes: List[ScopeTypeDef], # (1)
attributes: NotRequired[List[AttributeTypeDef]], # (2)
- See ScopeTypeDef
- 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)
- See ScopeTypeDef
- See AttributeTypeDef
ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef#
# ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef definition
class ListAssessmentRunAgentsRequestListAssessmentRunAgentsPaginateTypeDef(TypedDict):
assessmentRunArn: str,
filter: NotRequired[AgentFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)