Type definitions#
Auto-generated documentation for Macie2 type annotations stubs module mypy-boto3-macie2.
CriterionAdditionalPropertiesUnionTypeDef#
# CriterionAdditionalPropertiesUnionTypeDef definition
CriterionAdditionalPropertiesUnionTypeDef = Union[
CriterionAdditionalPropertiesTypeDef, # (1)
CriterionAdditionalPropertiesOutputTypeDef, # (2)
]
S3BucketDefinitionForJobUnionTypeDef#
# S3BucketDefinitionForJobUnionTypeDef definition
S3BucketDefinitionForJobUnionTypeDef = Union[
S3BucketDefinitionForJobTypeDef, # (1)
S3BucketDefinitionForJobOutputTypeDef, # (2)
]
SimpleCriterionForJobUnionTypeDef#
# SimpleCriterionForJobUnionTypeDef definition
SimpleCriterionForJobUnionTypeDef = Union[
SimpleCriterionForJobTypeDef, # (1)
SimpleCriterionForJobOutputTypeDef, # (2)
]
SimpleScopeTermUnionTypeDef#
# SimpleScopeTermUnionTypeDef definition
SimpleScopeTermUnionTypeDef = Union[
SimpleScopeTermTypeDef, # (1)
SimpleScopeTermOutputTypeDef, # (2)
]
TagCriterionForJobUnionTypeDef#
# TagCriterionForJobUnionTypeDef definition
TagCriterionForJobUnionTypeDef = Union[
TagCriterionForJobTypeDef, # (1)
TagCriterionForJobOutputTypeDef, # (2)
]
TagScopeTermUnionTypeDef#
# TagScopeTermUnionTypeDef definition
TagScopeTermUnionTypeDef = Union[
TagScopeTermTypeDef, # (1)
TagScopeTermOutputTypeDef, # (2)
]
CriteriaForJobUnionTypeDef#
# CriteriaForJobUnionTypeDef definition
CriteriaForJobUnionTypeDef = Union[
CriteriaForJobTypeDef, # (1)
CriteriaForJobOutputTypeDef, # (2)
]
JobScopeTermUnionTypeDef#
# JobScopeTermUnionTypeDef definition
JobScopeTermUnionTypeDef = Union[
JobScopeTermTypeDef, # (1)
JobScopeTermOutputTypeDef, # (2)
]
CriteriaBlockForJobUnionTypeDef#
# CriteriaBlockForJobUnionTypeDef definition
CriteriaBlockForJobUnionTypeDef = Union[
CriteriaBlockForJobTypeDef, # (1)
CriteriaBlockForJobOutputTypeDef, # (2)
]
JobScopingBlockUnionTypeDef#
# JobScopingBlockUnionTypeDef definition
JobScopingBlockUnionTypeDef = Union[
JobScopingBlockTypeDef, # (1)
JobScopingBlockOutputTypeDef, # (2)
]
S3BucketCriteriaForJobUnionTypeDef#
# S3BucketCriteriaForJobUnionTypeDef definition
S3BucketCriteriaForJobUnionTypeDef = Union[
S3BucketCriteriaForJobTypeDef, # (1)
S3BucketCriteriaForJobOutputTypeDef, # (2)
]
ScopingUnionTypeDef#
# ScopingUnionTypeDef definition
ScopingUnionTypeDef = Union[
ScopingTypeDef, # (1)
ScopingOutputTypeDef, # (2)
]
- See ScopingTypeDef
- See ScopingOutputTypeDef
AcceptInvitationRequestRequestTypeDef#
# AcceptInvitationRequestRequestTypeDef definition
class AcceptInvitationRequestRequestTypeDef(TypedDict):
invitationId: str,
administratorAccountId: NotRequired[str],
masterAccount: NotRequired[str],
AccessControlListTypeDef#
# AccessControlListTypeDef definition
class AccessControlListTypeDef(TypedDict):
allowsPublicReadAccess: NotRequired[bool],
allowsPublicWriteAccess: NotRequired[bool],
AccountDetailTypeDef#
# AccountDetailTypeDef definition
class AccountDetailTypeDef(TypedDict):
accountId: str,
email: str,
BlockPublicAccessTypeDef#
# BlockPublicAccessTypeDef definition
class BlockPublicAccessTypeDef(TypedDict):
blockPublicAcls: NotRequired[bool],
blockPublicPolicy: NotRequired[bool],
ignorePublicAcls: NotRequired[bool],
restrictPublicBuckets: NotRequired[bool],
AdminAccountTypeDef#
# AdminAccountTypeDef definition
class AdminAccountTypeDef(TypedDict):
accountId: NotRequired[str],
status: NotRequired[AdminStatusType], # (1)
- See AdminStatusType
S3WordsListTypeDef#
# S3WordsListTypeDef definition
class S3WordsListTypeDef(TypedDict):
bucketName: str,
objectKey: str,
AllowListStatusTypeDef#
# AllowListStatusTypeDef definition
class AllowListStatusTypeDef(TypedDict):
code: AllowListStatusCodeType, # (1)
description: NotRequired[str],
AllowListSummaryTypeDef#
# AllowListSummaryTypeDef definition
class AllowListSummaryTypeDef(TypedDict):
arn: NotRequired[str],
createdAt: NotRequired[datetime],
description: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
updatedAt: NotRequired[datetime],
ApiCallDetailsTypeDef#
# ApiCallDetailsTypeDef definition
class ApiCallDetailsTypeDef(TypedDict):
api: NotRequired[str],
apiServiceName: NotRequired[str],
firstSeen: NotRequired[datetime],
lastSeen: NotRequired[datetime],
AutomatedDiscoveryAccountTypeDef#
# AutomatedDiscoveryAccountTypeDef definition
class AutomatedDiscoveryAccountTypeDef(TypedDict):
accountId: NotRequired[str],
status: NotRequired[AutomatedDiscoveryAccountStatusType], # (1)
AutomatedDiscoveryAccountUpdateErrorTypeDef#
# AutomatedDiscoveryAccountUpdateErrorTypeDef definition
class AutomatedDiscoveryAccountUpdateErrorTypeDef(TypedDict):
accountId: NotRequired[str],
errorCode: NotRequired[AutomatedDiscoveryAccountUpdateErrorCodeType], # (1)
AutomatedDiscoveryAccountUpdateTypeDef#
# AutomatedDiscoveryAccountUpdateTypeDef definition
class AutomatedDiscoveryAccountUpdateTypeDef(TypedDict):
accountId: NotRequired[str],
status: NotRequired[AutomatedDiscoveryAccountStatusType], # (1)
AwsAccountTypeDef#
# AwsAccountTypeDef definition
class AwsAccountTypeDef(TypedDict):
accountId: NotRequired[str],
principalId: NotRequired[str],
AwsServiceTypeDef#
# AwsServiceTypeDef definition
class AwsServiceTypeDef(TypedDict):
invokedBy: NotRequired[str],
BatchGetCustomDataIdentifierSummaryTypeDef#
# BatchGetCustomDataIdentifierSummaryTypeDef definition
class BatchGetCustomDataIdentifierSummaryTypeDef(TypedDict):
arn: NotRequired[str],
createdAt: NotRequired[datetime],
deleted: NotRequired[bool],
description: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
BatchGetCustomDataIdentifiersRequestRequestTypeDef#
# BatchGetCustomDataIdentifiersRequestRequestTypeDef definition
class BatchGetCustomDataIdentifiersRequestRequestTypeDef(TypedDict):
ids: NotRequired[Sequence[str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
BucketCountByEffectivePermissionTypeDef#
# BucketCountByEffectivePermissionTypeDef definition
class BucketCountByEffectivePermissionTypeDef(TypedDict):
publiclyAccessible: NotRequired[int],
publiclyReadable: NotRequired[int],
publiclyWritable: NotRequired[int],
unknown: NotRequired[int],
BucketCountByEncryptionTypeTypeDef#
# BucketCountByEncryptionTypeTypeDef definition
class BucketCountByEncryptionTypeTypeDef(TypedDict):
kmsManaged: NotRequired[int],
s3Managed: NotRequired[int],
unencrypted: NotRequired[int],
unknown: NotRequired[int],
BucketCountBySharedAccessTypeTypeDef#
# BucketCountBySharedAccessTypeTypeDef definition
class BucketCountBySharedAccessTypeTypeDef(TypedDict):
external: NotRequired[int],
internal: NotRequired[int],
notShared: NotRequired[int],
unknown: NotRequired[int],
BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef#
# BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef definition
class BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef(TypedDict):
allowsUnencryptedObjectUploads: NotRequired[int],
deniesUnencryptedObjectUploads: NotRequired[int],
unknown: NotRequired[int],
BucketCriteriaAdditionalPropertiesTypeDef#
# BucketCriteriaAdditionalPropertiesTypeDef definition
class BucketCriteriaAdditionalPropertiesTypeDef(TypedDict):
eq: NotRequired[Sequence[str]],
gt: NotRequired[int],
gte: NotRequired[int],
lt: NotRequired[int],
lte: NotRequired[int],
neq: NotRequired[Sequence[str]],
prefix: NotRequired[str],
BucketPolicyTypeDef#
# BucketPolicyTypeDef definition
class BucketPolicyTypeDef(TypedDict):
allowsPublicReadAccess: NotRequired[bool],
allowsPublicWriteAccess: NotRequired[bool],
BucketServerSideEncryptionTypeDef#
# BucketServerSideEncryptionTypeDef definition
class BucketServerSideEncryptionTypeDef(TypedDict):
kmsMasterKeyId: NotRequired[str],
type: NotRequired[TypeType], # (1)
- See TypeType
JobDetailsTypeDef#
# JobDetailsTypeDef definition
class JobDetailsTypeDef(TypedDict):
isDefinedInJob: NotRequired[IsDefinedInJobType], # (1)
isMonitoredByJob: NotRequired[IsMonitoredByJobType], # (2)
lastJobId: NotRequired[str],
lastJobRunTime: NotRequired[datetime],
KeyValuePairTypeDef#
# KeyValuePairTypeDef definition
class KeyValuePairTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],
ObjectCountByEncryptionTypeTypeDef#
# ObjectCountByEncryptionTypeTypeDef definition
class ObjectCountByEncryptionTypeTypeDef(TypedDict):
customerManaged: NotRequired[int],
kmsManaged: NotRequired[int],
s3Managed: NotRequired[int],
unencrypted: NotRequired[int],
unknown: NotRequired[int],
ObjectLevelStatisticsTypeDef#
# ObjectLevelStatisticsTypeDef definition
class ObjectLevelStatisticsTypeDef(TypedDict):
fileType: NotRequired[int],
storageClass: NotRequired[int],
total: NotRequired[int],
ReplicationDetailsTypeDef#
# ReplicationDetailsTypeDef definition
class ReplicationDetailsTypeDef(TypedDict):
replicated: NotRequired[bool],
replicatedExternally: NotRequired[bool],
replicationAccounts: NotRequired[List[str]],
BucketSortCriteriaTypeDef#
# BucketSortCriteriaTypeDef definition
class BucketSortCriteriaTypeDef(TypedDict):
attributeName: NotRequired[str],
orderBy: NotRequired[OrderByType], # (1)
- See OrderByType
SensitivityAggregationsTypeDef#
# SensitivityAggregationsTypeDef definition
class SensitivityAggregationsTypeDef(TypedDict):
classifiableSizeInBytes: NotRequired[int],
publiclyAccessibleCount: NotRequired[int],
totalCount: NotRequired[int],
totalSizeInBytes: NotRequired[int],
CellTypeDef#
# CellTypeDef definition
class CellTypeDef(TypedDict):
cellReference: NotRequired[str],
column: NotRequired[int],
columnName: NotRequired[str],
row: NotRequired[int],
S3DestinationTypeDef#
# S3DestinationTypeDef definition
class S3DestinationTypeDef(TypedDict):
bucketName: str,
kmsKeyArn: str,
keyPrefix: NotRequired[str],
ClassificationResultStatusTypeDef#
# ClassificationResultStatusTypeDef definition
class ClassificationResultStatusTypeDef(TypedDict):
code: NotRequired[str],
reason: NotRequired[str],
ClassificationScopeSummaryTypeDef#
# ClassificationScopeSummaryTypeDef definition
class ClassificationScopeSummaryTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
SeverityLevelTypeDef#
# SeverityLevelTypeDef definition
class SeverityLevelTypeDef(TypedDict):
occurrencesThreshold: int,
severity: DataIdentifierSeverityType, # (1)
CreateInvitationsRequestRequestTypeDef#
# CreateInvitationsRequestRequestTypeDef definition
class CreateInvitationsRequestRequestTypeDef(TypedDict):
accountIds: Sequence[str],
disableEmailNotification: NotRequired[bool],
message: NotRequired[str],
UnprocessedAccountTypeDef#
# UnprocessedAccountTypeDef definition
class UnprocessedAccountTypeDef(TypedDict):
accountId: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
CreateSampleFindingsRequestRequestTypeDef#
# CreateSampleFindingsRequestRequestTypeDef definition
class CreateSampleFindingsRequestRequestTypeDef(TypedDict):
findingTypes: NotRequired[Sequence[FindingTypeType]], # (1)
- See FindingTypeType
SimpleCriterionForJobOutputTypeDef#
# SimpleCriterionForJobOutputTypeDef definition
class SimpleCriterionForJobOutputTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[SimpleCriterionKeyForJobType], # (2)
values: NotRequired[List[str]],
CriterionAdditionalPropertiesOutputTypeDef#
# CriterionAdditionalPropertiesOutputTypeDef definition
class CriterionAdditionalPropertiesOutputTypeDef(TypedDict):
eq: NotRequired[List[str]],
eqExactMatch: NotRequired[List[str]],
gt: NotRequired[int],
gte: NotRequired[int],
lt: NotRequired[int],
lte: NotRequired[int],
neq: NotRequired[List[str]],
CriterionAdditionalPropertiesTypeDef#
# CriterionAdditionalPropertiesTypeDef definition
class CriterionAdditionalPropertiesTypeDef(TypedDict):
eq: NotRequired[Sequence[str]],
eqExactMatch: NotRequired[Sequence[str]],
gt: NotRequired[int],
gte: NotRequired[int],
lt: NotRequired[int],
lte: NotRequired[int],
neq: NotRequired[Sequence[str]],
CustomDataIdentifierSummaryTypeDef#
# CustomDataIdentifierSummaryTypeDef definition
class CustomDataIdentifierSummaryTypeDef(TypedDict):
arn: NotRequired[str],
createdAt: NotRequired[datetime],
description: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
DeclineInvitationsRequestRequestTypeDef#
# DeclineInvitationsRequestRequestTypeDef definition
class DeclineInvitationsRequestRequestTypeDef(TypedDict):
accountIds: Sequence[str],
DeleteAllowListRequestRequestTypeDef#
# DeleteAllowListRequestRequestTypeDef definition
class DeleteAllowListRequestRequestTypeDef(TypedDict):
id: str,
ignoreJobChecks: NotRequired[str],
DeleteCustomDataIdentifierRequestRequestTypeDef#
# DeleteCustomDataIdentifierRequestRequestTypeDef definition
class DeleteCustomDataIdentifierRequestRequestTypeDef(TypedDict):
id: str,
DeleteFindingsFilterRequestRequestTypeDef#
# DeleteFindingsFilterRequestRequestTypeDef definition
class DeleteFindingsFilterRequestRequestTypeDef(TypedDict):
id: str,
DeleteInvitationsRequestRequestTypeDef#
# DeleteInvitationsRequestRequestTypeDef definition
class DeleteInvitationsRequestRequestTypeDef(TypedDict):
accountIds: Sequence[str],
DeleteMemberRequestRequestTypeDef#
# DeleteMemberRequestRequestTypeDef definition
class DeleteMemberRequestRequestTypeDef(TypedDict):
id: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeClassificationJobRequestRequestTypeDef#
# DescribeClassificationJobRequestRequestTypeDef definition
class DescribeClassificationJobRequestRequestTypeDef(TypedDict):
jobId: str,
LastRunErrorStatusTypeDef#
# LastRunErrorStatusTypeDef definition
class LastRunErrorStatusTypeDef(TypedDict):
code: NotRequired[LastRunErrorStatusCodeType], # (1)
StatisticsTypeDef#
# StatisticsTypeDef definition
class StatisticsTypeDef(TypedDict):
approximateNumberOfObjectsToProcess: NotRequired[float],
numberOfRuns: NotRequired[float],
UserPausedDetailsTypeDef#
# UserPausedDetailsTypeDef definition
class UserPausedDetailsTypeDef(TypedDict):
jobExpiresAt: NotRequired[datetime],
jobImminentExpirationHealthEventArn: NotRequired[str],
jobPausedAt: NotRequired[datetime],
DetectedDataDetailsTypeDef#
# DetectedDataDetailsTypeDef definition
class DetectedDataDetailsTypeDef(TypedDict):
value: str,
DetectionTypeDef#
# DetectionTypeDef definition
class DetectionTypeDef(TypedDict):
arn: NotRequired[str],
count: NotRequired[int],
id: NotRequired[str],
name: NotRequired[str],
suppressed: NotRequired[bool],
type: NotRequired[DataIdentifierTypeType], # (1)
DisableOrganizationAdminAccountRequestRequestTypeDef#
# DisableOrganizationAdminAccountRequestRequestTypeDef definition
class DisableOrganizationAdminAccountRequestRequestTypeDef(TypedDict):
adminAccountId: str,
DisassociateMemberRequestRequestTypeDef#
# DisassociateMemberRequestRequestTypeDef definition
class DisassociateMemberRequestRequestTypeDef(TypedDict):
id: str,
DomainDetailsTypeDef#
# DomainDetailsTypeDef definition
class DomainDetailsTypeDef(TypedDict):
domainName: NotRequired[str],
EnableMacieRequestRequestTypeDef#
# EnableMacieRequestRequestTypeDef definition
class EnableMacieRequestRequestTypeDef(TypedDict):
clientToken: NotRequired[str],
findingPublishingFrequency: NotRequired[FindingPublishingFrequencyType], # (1)
status: NotRequired[MacieStatusType], # (2)
EnableOrganizationAdminAccountRequestRequestTypeDef#
# EnableOrganizationAdminAccountRequestRequestTypeDef definition
class EnableOrganizationAdminAccountRequestRequestTypeDef(TypedDict):
adminAccountId: str,
clientToken: NotRequired[str],
FindingStatisticsSortCriteriaTypeDef#
# FindingStatisticsSortCriteriaTypeDef definition
class FindingStatisticsSortCriteriaTypeDef(TypedDict):
attributeName: NotRequired[FindingStatisticsSortAttributeNameType], # (1)
orderBy: NotRequired[OrderByType], # (2)
SeverityTypeDef#
# SeverityTypeDef definition
class SeverityTypeDef(TypedDict):
description: NotRequired[SeverityDescriptionType], # (1)
score: NotRequired[int],
FindingsFilterListItemTypeDef#
# FindingsFilterListItemTypeDef definition
class FindingsFilterListItemTypeDef(TypedDict):
action: NotRequired[FindingsFilterActionType], # (1)
arn: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
InvitationTypeDef#
# InvitationTypeDef definition
class InvitationTypeDef(TypedDict):
accountId: NotRequired[str],
invitationId: NotRequired[str],
invitedAt: NotRequired[datetime],
relationshipStatus: NotRequired[RelationshipStatusType], # (1)
GetAllowListRequestRequestTypeDef#
# GetAllowListRequestRequestTypeDef definition
class GetAllowListRequestRequestTypeDef(TypedDict):
id: str,
GetBucketStatisticsRequestRequestTypeDef#
# GetBucketStatisticsRequestRequestTypeDef definition
class GetBucketStatisticsRequestRequestTypeDef(TypedDict):
accountId: NotRequired[str],
GetClassificationScopeRequestRequestTypeDef#
# GetClassificationScopeRequestRequestTypeDef definition
class GetClassificationScopeRequestRequestTypeDef(TypedDict):
id: str,
GetCustomDataIdentifierRequestRequestTypeDef#
# GetCustomDataIdentifierRequestRequestTypeDef definition
class GetCustomDataIdentifierRequestRequestTypeDef(TypedDict):
id: str,
GroupCountTypeDef#
# GroupCountTypeDef definition
class GroupCountTypeDef(TypedDict):
count: NotRequired[int],
groupKey: NotRequired[str],
GetFindingsFilterRequestRequestTypeDef#
# GetFindingsFilterRequestRequestTypeDef definition
class GetFindingsFilterRequestRequestTypeDef(TypedDict):
id: str,
SecurityHubConfigurationTypeDef#
# SecurityHubConfigurationTypeDef definition
class SecurityHubConfigurationTypeDef(TypedDict):
publishClassificationFindings: bool,
publishPolicyFindings: bool,
SortCriteriaTypeDef#
# SortCriteriaTypeDef definition
class SortCriteriaTypeDef(TypedDict):
attributeName: NotRequired[str],
orderBy: NotRequired[OrderByType], # (1)
- See OrderByType
GetMemberRequestRequestTypeDef#
# GetMemberRequestRequestTypeDef definition
class GetMemberRequestRequestTypeDef(TypedDict):
id: str,
GetResourceProfileRequestRequestTypeDef#
# GetResourceProfileRequestRequestTypeDef definition
class GetResourceProfileRequestRequestTypeDef(TypedDict):
resourceArn: str,
ResourceStatisticsTypeDef#
# ResourceStatisticsTypeDef definition
class ResourceStatisticsTypeDef(TypedDict):
totalBytesClassified: NotRequired[int],
totalDetections: NotRequired[int],
totalDetectionsSuppressed: NotRequired[int],
totalItemsClassified: NotRequired[int],
totalItemsSensitive: NotRequired[int],
totalItemsSkipped: NotRequired[int],
totalItemsSkippedInvalidEncryption: NotRequired[int],
totalItemsSkippedInvalidKms: NotRequired[int],
totalItemsSkippedPermissionDenied: NotRequired[int],
RetrievalConfigurationTypeDef#
# RetrievalConfigurationTypeDef definition
class RetrievalConfigurationTypeDef(TypedDict):
retrievalMode: RetrievalModeType, # (1)
externalId: NotRequired[str],
roleName: NotRequired[str],
RevealConfigurationTypeDef#
# RevealConfigurationTypeDef definition
class RevealConfigurationTypeDef(TypedDict):
status: RevealStatusType, # (1)
kmsKeyId: NotRequired[str],
- See RevealStatusType
GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef#
# GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef definition
class GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef(TypedDict):
findingId: str,
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
GetSensitiveDataOccurrencesRequestRequestTypeDef#
# GetSensitiveDataOccurrencesRequestRequestTypeDef definition
class GetSensitiveDataOccurrencesRequestRequestTypeDef(TypedDict):
findingId: str,
GetSensitivityInspectionTemplateRequestRequestTypeDef#
# GetSensitivityInspectionTemplateRequestRequestTypeDef definition
class GetSensitivityInspectionTemplateRequestRequestTypeDef(TypedDict):
id: str,
SensitivityInspectionTemplateExcludesOutputTypeDef#
# SensitivityInspectionTemplateExcludesOutputTypeDef definition
class SensitivityInspectionTemplateExcludesOutputTypeDef(TypedDict):
managedDataIdentifierIds: NotRequired[List[str]],
SensitivityInspectionTemplateIncludesOutputTypeDef#
# SensitivityInspectionTemplateIncludesOutputTypeDef definition
class SensitivityInspectionTemplateIncludesOutputTypeDef(TypedDict):
allowListIds: NotRequired[List[str]],
customDataIdentifierIds: NotRequired[List[str]],
managedDataIdentifierIds: NotRequired[List[str]],
UsageStatisticsFilterTypeDef#
# UsageStatisticsFilterTypeDef definition
class UsageStatisticsFilterTypeDef(TypedDict):
comparator: NotRequired[UsageStatisticsFilterComparatorType], # (1)
key: NotRequired[UsageStatisticsFilterKeyType], # (2)
values: NotRequired[Sequence[str]],
UsageStatisticsSortByTypeDef#
# UsageStatisticsSortByTypeDef definition
class UsageStatisticsSortByTypeDef(TypedDict):
key: NotRequired[UsageStatisticsSortKeyType], # (1)
orderBy: NotRequired[OrderByType], # (2)
GetUsageTotalsRequestRequestTypeDef#
# GetUsageTotalsRequestRequestTypeDef definition
class GetUsageTotalsRequestRequestTypeDef(TypedDict):
timeRange: NotRequired[str],
UsageTotalTypeDef#
# UsageTotalTypeDef definition
class UsageTotalTypeDef(TypedDict):
currency: NotRequired[CurrencyType], # (1)
estimatedCost: NotRequired[str],
type: NotRequired[UsageTypeType], # (2)
- See CurrencyType
- See UsageTypeType
IamUserTypeDef#
# IamUserTypeDef definition
class IamUserTypeDef(TypedDict):
accountId: NotRequired[str],
arn: NotRequired[str],
principalId: NotRequired[str],
userName: NotRequired[str],
IpCityTypeDef#
# IpCityTypeDef definition
class IpCityTypeDef(TypedDict):
name: NotRequired[str],
IpCountryTypeDef#
# IpCountryTypeDef definition
class IpCountryTypeDef(TypedDict):
code: NotRequired[str],
name: NotRequired[str],
IpGeoLocationTypeDef#
# IpGeoLocationTypeDef definition
class IpGeoLocationTypeDef(TypedDict):
lat: NotRequired[float],
lon: NotRequired[float],
IpOwnerTypeDef#
# IpOwnerTypeDef definition
class IpOwnerTypeDef(TypedDict):
asn: NotRequired[str],
asnOrg: NotRequired[str],
isp: NotRequired[str],
org: NotRequired[str],
MonthlyScheduleTypeDef#
# MonthlyScheduleTypeDef definition
class MonthlyScheduleTypeDef(TypedDict):
dayOfMonth: NotRequired[int],
WeeklyScheduleTypeDef#
# WeeklyScheduleTypeDef definition
class WeeklyScheduleTypeDef(TypedDict):
dayOfWeek: NotRequired[DayOfWeekType], # (1)
- See DayOfWeekType
SimpleScopeTermOutputTypeDef#
# SimpleScopeTermOutputTypeDef definition
class SimpleScopeTermOutputTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[ScopeFilterKeyType], # (2)
values: NotRequired[List[str]],
- See JobComparatorType
- See ScopeFilterKeyType
S3BucketDefinitionForJobOutputTypeDef#
# S3BucketDefinitionForJobOutputTypeDef definition
class S3BucketDefinitionForJobOutputTypeDef(TypedDict):
accountId: str,
buckets: List[str],
ListAllowListsRequestRequestTypeDef#
# ListAllowListsRequestRequestTypeDef definition
class ListAllowListsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAutomatedDiscoveryAccountsRequestRequestTypeDef#
# ListAutomatedDiscoveryAccountsRequestRequestTypeDef definition
class ListAutomatedDiscoveryAccountsRequestRequestTypeDef(TypedDict):
accountIds: NotRequired[Sequence[str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListJobsSortCriteriaTypeDef#
# ListJobsSortCriteriaTypeDef definition
class ListJobsSortCriteriaTypeDef(TypedDict):
attributeName: NotRequired[ListJobsSortAttributeNameType], # (1)
orderBy: NotRequired[OrderByType], # (2)
ListClassificationScopesRequestRequestTypeDef#
# ListClassificationScopesRequestRequestTypeDef definition
class ListClassificationScopesRequestRequestTypeDef(TypedDict):
name: NotRequired[str],
nextToken: NotRequired[str],
ListCustomDataIdentifiersRequestRequestTypeDef#
# ListCustomDataIdentifiersRequestRequestTypeDef definition
class ListCustomDataIdentifiersRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListFindingsFiltersRequestRequestTypeDef#
# ListFindingsFiltersRequestRequestTypeDef definition
class ListFindingsFiltersRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListInvitationsRequestRequestTypeDef#
# ListInvitationsRequestRequestTypeDef definition
class ListInvitationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListJobsFilterTermTypeDef#
# ListJobsFilterTermTypeDef definition
class ListJobsFilterTermTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[ListJobsFilterKeyType], # (2)
values: NotRequired[Sequence[str]],
ListManagedDataIdentifiersRequestRequestTypeDef#
# ListManagedDataIdentifiersRequestRequestTypeDef definition
class ListManagedDataIdentifiersRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
ManagedDataIdentifierSummaryTypeDef#
# ManagedDataIdentifierSummaryTypeDef definition
class ManagedDataIdentifierSummaryTypeDef(TypedDict):
category: NotRequired[SensitiveDataItemCategoryType], # (1)
id: NotRequired[str],
ListMembersRequestRequestTypeDef#
# ListMembersRequestRequestTypeDef definition
class ListMembersRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
onlyAssociated: NotRequired[str],
MemberTypeDef#
# MemberTypeDef definition
class MemberTypeDef(TypedDict):
accountId: NotRequired[str],
administratorAccountId: NotRequired[str],
arn: NotRequired[str],
email: NotRequired[str],
invitedAt: NotRequired[datetime],
masterAccountId: NotRequired[str],
relationshipStatus: NotRequired[RelationshipStatusType], # (1)
tags: NotRequired[Dict[str, str]],
updatedAt: NotRequired[datetime],
ListOrganizationAdminAccountsRequestRequestTypeDef#
# ListOrganizationAdminAccountsRequestRequestTypeDef definition
class ListOrganizationAdminAccountsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListResourceProfileArtifactsRequestRequestTypeDef#
# ListResourceProfileArtifactsRequestRequestTypeDef definition
class ListResourceProfileArtifactsRequestRequestTypeDef(TypedDict):
resourceArn: str,
nextToken: NotRequired[str],
ResourceProfileArtifactTypeDef#
# ResourceProfileArtifactTypeDef definition
class ResourceProfileArtifactTypeDef(TypedDict):
arn: str,
classificationResultStatus: str,
sensitive: NotRequired[bool],
ListResourceProfileDetectionsRequestRequestTypeDef#
# ListResourceProfileDetectionsRequestRequestTypeDef definition
class ListResourceProfileDetectionsRequestRequestTypeDef(TypedDict):
resourceArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListSensitivityInspectionTemplatesRequestRequestTypeDef#
# ListSensitivityInspectionTemplatesRequestRequestTypeDef definition
class ListSensitivityInspectionTemplatesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SensitivityInspectionTemplatesEntryTypeDef#
# SensitivityInspectionTemplatesEntryTypeDef definition
class SensitivityInspectionTemplatesEntryTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
RangeTypeDef#
# RangeTypeDef definition
class RangeTypeDef(TypedDict):
end: NotRequired[int],
start: NotRequired[int],
startColumn: NotRequired[int],
RecordTypeDef#
# RecordTypeDef definition
class RecordTypeDef(TypedDict):
jsonPath: NotRequired[str],
recordIndex: NotRequired[int],
S3BucketDefinitionForJobTypeDef#
# S3BucketDefinitionForJobTypeDef definition
class S3BucketDefinitionForJobTypeDef(TypedDict):
accountId: str,
buckets: Sequence[str],
S3BucketOwnerTypeDef#
# S3BucketOwnerTypeDef definition
class S3BucketOwnerTypeDef(TypedDict):
displayName: NotRequired[str],
id: NotRequired[str],
ServerSideEncryptionTypeDef#
# ServerSideEncryptionTypeDef definition
class ServerSideEncryptionTypeDef(TypedDict):
encryptionType: NotRequired[EncryptionTypeType], # (1)
kmsMasterKeyId: NotRequired[str],
S3ClassificationScopeExclusionTypeDef#
# S3ClassificationScopeExclusionTypeDef definition
class S3ClassificationScopeExclusionTypeDef(TypedDict):
bucketNames: List[str],
S3ClassificationScopeExclusionUpdateTypeDef#
# S3ClassificationScopeExclusionUpdateTypeDef definition
class S3ClassificationScopeExclusionUpdateTypeDef(TypedDict):
bucketNames: Sequence[str],
operation: ClassificationScopeUpdateOperationType, # (1)
SearchResourcesSimpleCriterionTypeDef#
# SearchResourcesSimpleCriterionTypeDef definition
class SearchResourcesSimpleCriterionTypeDef(TypedDict):
comparator: NotRequired[SearchResourcesComparatorType], # (1)
key: NotRequired[SearchResourcesSimpleCriterionKeyType], # (2)
values: NotRequired[Sequence[str]],
SearchResourcesSortCriteriaTypeDef#
# SearchResourcesSortCriteriaTypeDef definition
class SearchResourcesSortCriteriaTypeDef(TypedDict):
attributeName: NotRequired[SearchResourcesSortAttributeNameType], # (1)
orderBy: NotRequired[OrderByType], # (2)
SearchResourcesTagCriterionPairTypeDef#
# SearchResourcesTagCriterionPairTypeDef definition
class SearchResourcesTagCriterionPairTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],
SensitivityInspectionTemplateExcludesTypeDef#
# SensitivityInspectionTemplateExcludesTypeDef definition
class SensitivityInspectionTemplateExcludesTypeDef(TypedDict):
managedDataIdentifierIds: NotRequired[Sequence[str]],
SensitivityInspectionTemplateIncludesTypeDef#
# SensitivityInspectionTemplateIncludesTypeDef definition
class SensitivityInspectionTemplateIncludesTypeDef(TypedDict):
allowListIds: NotRequired[Sequence[str]],
customDataIdentifierIds: NotRequired[Sequence[str]],
managedDataIdentifierIds: NotRequired[Sequence[str]],
ServiceLimitTypeDef#
# ServiceLimitTypeDef definition
class ServiceLimitTypeDef(TypedDict):
isServiceLimited: NotRequired[bool],
unit: NotRequired[UnitType], # (1)
value: NotRequired[int],
- See UnitType
SessionContextAttributesTypeDef#
# SessionContextAttributesTypeDef definition
class SessionContextAttributesTypeDef(TypedDict):
creationDate: NotRequired[datetime],
mfaAuthenticated: NotRequired[bool],
SessionIssuerTypeDef#
# SessionIssuerTypeDef definition
class SessionIssuerTypeDef(TypedDict):
accountId: NotRequired[str],
arn: NotRequired[str],
principalId: NotRequired[str],
type: NotRequired[str],
userName: NotRequired[str],
SimpleCriterionForJobTypeDef#
# SimpleCriterionForJobTypeDef definition
class SimpleCriterionForJobTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[SimpleCriterionKeyForJobType], # (2)
values: NotRequired[Sequence[str]],
SimpleScopeTermTypeDef#
# SimpleScopeTermTypeDef definition
class SimpleScopeTermTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[ScopeFilterKeyType], # (2)
values: NotRequired[Sequence[str]],
- See JobComparatorType
- See ScopeFilterKeyType
SuppressDataIdentifierTypeDef#
# SuppressDataIdentifierTypeDef definition
class SuppressDataIdentifierTypeDef(TypedDict):
id: NotRequired[str],
type: NotRequired[DataIdentifierTypeType], # (1)
TagCriterionPairForJobTypeDef#
# TagCriterionPairForJobTypeDef definition
class TagCriterionPairForJobTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
TagValuePairTypeDef#
# TagValuePairTypeDef definition
class TagValuePairTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],
TestCustomDataIdentifierRequestRequestTypeDef#
# TestCustomDataIdentifierRequestRequestTypeDef definition
class TestCustomDataIdentifierRequestRequestTypeDef(TypedDict):
regex: str,
sampleText: str,
ignoreWords: NotRequired[Sequence[str]],
keywords: NotRequired[Sequence[str]],
maximumMatchDistance: NotRequired[int],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef#
# UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef definition
class UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef(TypedDict):
status: AutomatedDiscoveryStatusType, # (1)
autoEnableOrganizationMembers: NotRequired[AutoEnableModeType], # (2)
UpdateClassificationJobRequestRequestTypeDef#
# UpdateClassificationJobRequestRequestTypeDef definition
class UpdateClassificationJobRequestRequestTypeDef(TypedDict):
jobId: str,
jobStatus: JobStatusType, # (1)
- See JobStatusType
UpdateMacieSessionRequestRequestTypeDef#
# UpdateMacieSessionRequestRequestTypeDef definition
class UpdateMacieSessionRequestRequestTypeDef(TypedDict):
findingPublishingFrequency: NotRequired[FindingPublishingFrequencyType], # (1)
status: NotRequired[MacieStatusType], # (2)
UpdateMemberSessionRequestRequestTypeDef#
# UpdateMemberSessionRequestRequestTypeDef definition
class UpdateMemberSessionRequestRequestTypeDef(TypedDict):
id: str,
status: MacieStatusType, # (1)
- See MacieStatusType
UpdateOrganizationConfigurationRequestRequestTypeDef#
# UpdateOrganizationConfigurationRequestRequestTypeDef definition
class UpdateOrganizationConfigurationRequestRequestTypeDef(TypedDict):
autoEnable: bool,
UpdateResourceProfileRequestRequestTypeDef#
# UpdateResourceProfileRequestRequestTypeDef definition
class UpdateResourceProfileRequestRequestTypeDef(TypedDict):
resourceArn: str,
sensitivityScoreOverride: NotRequired[int],
UpdateRetrievalConfigurationTypeDef#
# UpdateRetrievalConfigurationTypeDef definition
class UpdateRetrievalConfigurationTypeDef(TypedDict):
retrievalMode: RetrievalModeType, # (1)
roleName: NotRequired[str],
UserIdentityRootTypeDef#
# UserIdentityRootTypeDef definition
class UserIdentityRootTypeDef(TypedDict):
accountId: NotRequired[str],
arn: NotRequired[str],
principalId: NotRequired[str],
CreateMemberRequestRequestTypeDef#
# CreateMemberRequestRequestTypeDef definition
class CreateMemberRequestRequestTypeDef(TypedDict):
account: AccountDetailTypeDef, # (1)
tags: NotRequired[Mapping[str, str]],
AccountLevelPermissionsTypeDef#
# AccountLevelPermissionsTypeDef definition
class AccountLevelPermissionsTypeDef(TypedDict):
blockPublicAccess: NotRequired[BlockPublicAccessTypeDef], # (1)
AllowListCriteriaTypeDef#
# AllowListCriteriaTypeDef definition
class AllowListCriteriaTypeDef(TypedDict):
regex: NotRequired[str],
s3WordsList: NotRequired[S3WordsListTypeDef], # (1)
FindingActionTypeDef#
# FindingActionTypeDef definition
class FindingActionTypeDef(TypedDict):
actionType: NotRequired[FindingActionTypeType], # (1)
apiCallDetails: NotRequired[ApiCallDetailsTypeDef], # (2)
BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef#
# BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef definition
class BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef(TypedDict):
accounts: NotRequired[Sequence[AutomatedDiscoveryAccountUpdateTypeDef]], # (1)
BatchGetCustomDataIdentifiersResponseTypeDef#
# BatchGetCustomDataIdentifiersResponseTypeDef definition
class BatchGetCustomDataIdentifiersResponseTypeDef(TypedDict):
customDataIdentifiers: List[BatchGetCustomDataIdentifierSummaryTypeDef], # (1)
notFoundIdentifierIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef#
# BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef definition
class BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef(TypedDict):
errors: List[AutomatedDiscoveryAccountUpdateErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAllowListResponseTypeDef#
# CreateAllowListResponseTypeDef definition
class CreateAllowListResponseTypeDef(TypedDict):
arn: str,
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateClassificationJobResponseTypeDef#
# CreateClassificationJobResponseTypeDef definition
class CreateClassificationJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCustomDataIdentifierResponseTypeDef#
# CreateCustomDataIdentifierResponseTypeDef definition
class CreateCustomDataIdentifierResponseTypeDef(TypedDict):
customDataIdentifierId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFindingsFilterResponseTypeDef#
# CreateFindingsFilterResponseTypeDef definition
class CreateFindingsFilterResponseTypeDef(TypedDict):
arn: str,
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMemberResponseTypeDef#
# CreateMemberResponseTypeDef definition
class CreateMemberResponseTypeDef(TypedDict):
arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeOrganizationConfigurationResponseTypeDef#
# DescribeOrganizationConfigurationResponseTypeDef definition
class DescribeOrganizationConfigurationResponseTypeDef(TypedDict):
autoEnable: bool,
maxAccountLimitReached: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAutomatedDiscoveryConfigurationResponseTypeDef#
# GetAutomatedDiscoveryConfigurationResponseTypeDef definition
class GetAutomatedDiscoveryConfigurationResponseTypeDef(TypedDict):
autoEnableOrganizationMembers: AutoEnableModeType, # (1)
classificationScopeId: str,
disabledAt: datetime,
firstEnabledAt: datetime,
lastUpdatedAt: datetime,
sensitivityInspectionTemplateId: str,
status: AutomatedDiscoveryStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetInvitationsCountResponseTypeDef#
# GetInvitationsCountResponseTypeDef definition
class GetInvitationsCountResponseTypeDef(TypedDict):
invitationsCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetMacieSessionResponseTypeDef#
# GetMacieSessionResponseTypeDef definition
class GetMacieSessionResponseTypeDef(TypedDict):
createdAt: datetime,
findingPublishingFrequency: FindingPublishingFrequencyType, # (1)
serviceRole: str,
status: MacieStatusType, # (2)
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetMemberResponseTypeDef#
# GetMemberResponseTypeDef definition
class GetMemberResponseTypeDef(TypedDict):
accountId: str,
administratorAccountId: str,
arn: str,
email: str,
invitedAt: datetime,
masterAccountId: str,
relationshipStatus: RelationshipStatusType, # (1)
tags: Dict[str, str],
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSensitiveDataOccurrencesAvailabilityResponseTypeDef#
# GetSensitiveDataOccurrencesAvailabilityResponseTypeDef definition
class GetSensitiveDataOccurrencesAvailabilityResponseTypeDef(TypedDict):
code: AvailabilityCodeType, # (1)
reasons: List[UnavailabilityReasonCodeType], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListAllowListsResponseTypeDef#
# ListAllowListsResponseTypeDef definition
class ListAllowListsResponseTypeDef(TypedDict):
allowLists: List[AllowListSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListAutomatedDiscoveryAccountsResponseTypeDef#
# ListAutomatedDiscoveryAccountsResponseTypeDef definition
class ListAutomatedDiscoveryAccountsResponseTypeDef(TypedDict):
items: List[AutomatedDiscoveryAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListFindingsResponseTypeDef#
# ListFindingsResponseTypeDef definition
class ListFindingsResponseTypeDef(TypedDict):
findingIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
ListOrganizationAdminAccountsResponseTypeDef#
# ListOrganizationAdminAccountsResponseTypeDef definition
class ListOrganizationAdminAccountsResponseTypeDef(TypedDict):
adminAccounts: List[AdminAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestCustomDataIdentifierResponseTypeDef#
# TestCustomDataIdentifierResponseTypeDef definition
class TestCustomDataIdentifierResponseTypeDef(TypedDict):
matchCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAllowListResponseTypeDef#
# UpdateAllowListResponseTypeDef definition
class UpdateAllowListResponseTypeDef(TypedDict):
arn: str,
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateFindingsFilterResponseTypeDef#
# UpdateFindingsFilterResponseTypeDef definition
class UpdateFindingsFilterResponseTypeDef(TypedDict):
arn: str,
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BucketLevelPermissionsTypeDef#
# BucketLevelPermissionsTypeDef definition
class BucketLevelPermissionsTypeDef(TypedDict):
accessControlList: NotRequired[AccessControlListTypeDef], # (1)
blockPublicAccess: NotRequired[BlockPublicAccessTypeDef], # (2)
bucketPolicy: NotRequired[BucketPolicyTypeDef], # (3)
MatchingBucketTypeDef#
# MatchingBucketTypeDef definition
class MatchingBucketTypeDef(TypedDict):
accountId: NotRequired[str],
automatedDiscoveryMonitoringStatus: NotRequired[AutomatedDiscoveryMonitoringStatusType], # (1)
bucketName: NotRequired[str],
classifiableObjectCount: NotRequired[int],
classifiableSizeInBytes: NotRequired[int],
errorCode: NotRequired[BucketMetadataErrorCodeType], # (2)
errorMessage: NotRequired[str],
jobDetails: NotRequired[JobDetailsTypeDef], # (3)
lastAutomatedDiscoveryTime: NotRequired[datetime],
objectCount: NotRequired[int],
objectCountByEncryptionType: NotRequired[ObjectCountByEncryptionTypeTypeDef], # (4)
sensitivityScore: NotRequired[int],
sizeInBytes: NotRequired[int],
sizeInBytesCompressed: NotRequired[int],
unclassifiableObjectCount: NotRequired[ObjectLevelStatisticsTypeDef], # (5)
unclassifiableObjectSizeInBytes: NotRequired[ObjectLevelStatisticsTypeDef], # (5)
- See AutomatedDiscoveryMonitoringStatusType
- See BucketMetadataErrorCodeType
- See JobDetailsTypeDef
- See ObjectCountByEncryptionTypeTypeDef
- See ObjectLevelStatisticsTypeDef
- See ObjectLevelStatisticsTypeDef
DescribeBucketsRequestRequestTypeDef#
# DescribeBucketsRequestRequestTypeDef definition
class DescribeBucketsRequestRequestTypeDef(TypedDict):
criteria: NotRequired[Mapping[str, BucketCriteriaAdditionalPropertiesTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortCriteria: NotRequired[BucketSortCriteriaTypeDef], # (2)
BucketStatisticsBySensitivityTypeDef#
# BucketStatisticsBySensitivityTypeDef definition
class BucketStatisticsBySensitivityTypeDef(TypedDict):
classificationError: NotRequired[SensitivityAggregationsTypeDef], # (1)
notClassified: NotRequired[SensitivityAggregationsTypeDef], # (1)
notSensitive: NotRequired[SensitivityAggregationsTypeDef], # (1)
sensitive: NotRequired[SensitivityAggregationsTypeDef], # (1)
- See SensitivityAggregationsTypeDef
- See SensitivityAggregationsTypeDef
- See SensitivityAggregationsTypeDef
- See SensitivityAggregationsTypeDef
ClassificationExportConfigurationTypeDef#
# ClassificationExportConfigurationTypeDef definition
class ClassificationExportConfigurationTypeDef(TypedDict):
s3Destination: NotRequired[S3DestinationTypeDef], # (1)
ListClassificationScopesResponseTypeDef#
# ListClassificationScopesResponseTypeDef definition
class ListClassificationScopesResponseTypeDef(TypedDict):
classificationScopes: List[ClassificationScopeSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CreateCustomDataIdentifierRequestRequestTypeDef#
# CreateCustomDataIdentifierRequestRequestTypeDef definition
class CreateCustomDataIdentifierRequestRequestTypeDef(TypedDict):
name: str,
regex: str,
clientToken: NotRequired[str],
description: NotRequired[str],
ignoreWords: NotRequired[Sequence[str]],
keywords: NotRequired[Sequence[str]],
maximumMatchDistance: NotRequired[int],
severityLevels: NotRequired[Sequence[SeverityLevelTypeDef]], # (1)
tags: NotRequired[Mapping[str, str]],
GetCustomDataIdentifierResponseTypeDef#
# GetCustomDataIdentifierResponseTypeDef definition
class GetCustomDataIdentifierResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
deleted: bool,
description: str,
id: str,
ignoreWords: List[str],
keywords: List[str],
maximumMatchDistance: int,
name: str,
regex: str,
severityLevels: List[SeverityLevelTypeDef], # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateInvitationsResponseTypeDef#
# CreateInvitationsResponseTypeDef definition
class CreateInvitationsResponseTypeDef(TypedDict):
unprocessedAccounts: List[UnprocessedAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeclineInvitationsResponseTypeDef#
# DeclineInvitationsResponseTypeDef definition
class DeclineInvitationsResponseTypeDef(TypedDict):
unprocessedAccounts: List[UnprocessedAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteInvitationsResponseTypeDef#
# DeleteInvitationsResponseTypeDef definition
class DeleteInvitationsResponseTypeDef(TypedDict):
unprocessedAccounts: List[UnprocessedAccountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FindingCriteriaOutputTypeDef#
# FindingCriteriaOutputTypeDef definition
class FindingCriteriaOutputTypeDef(TypedDict):
criterion: NotRequired[Dict[str, CriterionAdditionalPropertiesOutputTypeDef]], # (1)
ListCustomDataIdentifiersResponseTypeDef#
# ListCustomDataIdentifiersResponseTypeDef definition
class ListCustomDataIdentifiersResponseTypeDef(TypedDict):
items: List[CustomDataIdentifierSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
DescribeBucketsRequestDescribeBucketsPaginateTypeDef#
# DescribeBucketsRequestDescribeBucketsPaginateTypeDef definition
class DescribeBucketsRequestDescribeBucketsPaginateTypeDef(TypedDict):
criteria: NotRequired[Mapping[str, BucketCriteriaAdditionalPropertiesTypeDef]], # (1)
sortCriteria: NotRequired[BucketSortCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See BucketCriteriaAdditionalPropertiesTypeDef
- See BucketSortCriteriaTypeDef
- See PaginatorConfigTypeDef
ListAllowListsRequestListAllowListsPaginateTypeDef#
# ListAllowListsRequestListAllowListsPaginateTypeDef definition
class ListAllowListsRequestListAllowListsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAutomatedDiscoveryAccountsRequestListAutomatedDiscoveryAccountsPaginateTypeDef#
# ListAutomatedDiscoveryAccountsRequestListAutomatedDiscoveryAccountsPaginateTypeDef definition
class ListAutomatedDiscoveryAccountsRequestListAutomatedDiscoveryAccountsPaginateTypeDef(TypedDict):
accountIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClassificationScopesRequestListClassificationScopesPaginateTypeDef#
# ListClassificationScopesRequestListClassificationScopesPaginateTypeDef definition
class ListClassificationScopesRequestListClassificationScopesPaginateTypeDef(TypedDict):
name: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef#
# ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef definition
class ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef#
# ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef definition
class ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListInvitationsRequestListInvitationsPaginateTypeDef#
# ListInvitationsRequestListInvitationsPaginateTypeDef definition
class ListInvitationsRequestListInvitationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef#
# ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef definition
class ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListMembersRequestListMembersPaginateTypeDef#
# ListMembersRequestListMembersPaginateTypeDef definition
class ListMembersRequestListMembersPaginateTypeDef(TypedDict):
onlyAssociated: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef#
# ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef definition
class ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef#
# ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef definition
class ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef#
# ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef definition
class ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef#
# ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef definition
class ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSensitiveDataOccurrencesResponseTypeDef#
# GetSensitiveDataOccurrencesResponseTypeDef definition
class GetSensitiveDataOccurrencesResponseTypeDef(TypedDict):
error: str,
sensitiveDataOccurrences: Dict[str, List[DetectedDataDetailsTypeDef]], # (1)
status: RevealRequestStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListResourceProfileDetectionsResponseTypeDef#
# ListResourceProfileDetectionsResponseTypeDef definition
class ListResourceProfileDetectionsResponseTypeDef(TypedDict):
detections: List[DetectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListFindingsFiltersResponseTypeDef#
# ListFindingsFiltersResponseTypeDef definition
class ListFindingsFiltersResponseTypeDef(TypedDict):
findingsFilterListItems: List[FindingsFilterListItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetAdministratorAccountResponseTypeDef#
# GetAdministratorAccountResponseTypeDef definition
class GetAdministratorAccountResponseTypeDef(TypedDict):
administrator: InvitationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMasterAccountResponseTypeDef#
# GetMasterAccountResponseTypeDef definition
class GetMasterAccountResponseTypeDef(TypedDict):
master: InvitationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListInvitationsResponseTypeDef#
# ListInvitationsResponseTypeDef definition
class ListInvitationsResponseTypeDef(TypedDict):
invitations: List[InvitationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetFindingStatisticsResponseTypeDef#
# GetFindingStatisticsResponseTypeDef definition
class GetFindingStatisticsResponseTypeDef(TypedDict):
countsByGroup: List[GroupCountTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFindingsPublicationConfigurationResponseTypeDef#
# GetFindingsPublicationConfigurationResponseTypeDef definition
class GetFindingsPublicationConfigurationResponseTypeDef(TypedDict):
securityHubConfiguration: SecurityHubConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutFindingsPublicationConfigurationRequestRequestTypeDef#
# PutFindingsPublicationConfigurationRequestRequestTypeDef definition
class PutFindingsPublicationConfigurationRequestRequestTypeDef(TypedDict):
clientToken: NotRequired[str],
securityHubConfiguration: NotRequired[SecurityHubConfigurationTypeDef], # (1)
GetFindingsRequestRequestTypeDef#
# GetFindingsRequestRequestTypeDef definition
class GetFindingsRequestRequestTypeDef(TypedDict):
findingIds: Sequence[str],
sortCriteria: NotRequired[SortCriteriaTypeDef], # (1)
GetResourceProfileResponseTypeDef#
# GetResourceProfileResponseTypeDef definition
class GetResourceProfileResponseTypeDef(TypedDict):
profileUpdatedAt: datetime,
sensitivityScore: int,
sensitivityScoreOverridden: bool,
statistics: ResourceStatisticsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRevealConfigurationResponseTypeDef#
# GetRevealConfigurationResponseTypeDef definition
class GetRevealConfigurationResponseTypeDef(TypedDict):
configuration: RevealConfigurationTypeDef, # (1)
retrievalConfiguration: RetrievalConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateRevealConfigurationResponseTypeDef#
# UpdateRevealConfigurationResponseTypeDef definition
class UpdateRevealConfigurationResponseTypeDef(TypedDict):
configuration: RevealConfigurationTypeDef, # (1)
retrievalConfiguration: RetrievalConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetSensitiveDataOccurrencesRequestFindingRevealedWaitTypeDef#
# GetSensitiveDataOccurrencesRequestFindingRevealedWaitTypeDef definition
class GetSensitiveDataOccurrencesRequestFindingRevealedWaitTypeDef(TypedDict):
findingId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
GetSensitivityInspectionTemplateResponseTypeDef#
# GetSensitivityInspectionTemplateResponseTypeDef definition
class GetSensitivityInspectionTemplateResponseTypeDef(TypedDict):
description: str,
excludes: SensitivityInspectionTemplateExcludesOutputTypeDef, # (1)
includes: SensitivityInspectionTemplateIncludesOutputTypeDef, # (2)
name: str,
sensitivityInspectionTemplateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See SensitivityInspectionTemplateExcludesOutputTypeDef
- See SensitivityInspectionTemplateIncludesOutputTypeDef
- See ResponseMetadataTypeDef
GetUsageStatisticsRequestGetUsageStatisticsPaginateTypeDef#
# GetUsageStatisticsRequestGetUsageStatisticsPaginateTypeDef definition
class GetUsageStatisticsRequestGetUsageStatisticsPaginateTypeDef(TypedDict):
filterBy: NotRequired[Sequence[UsageStatisticsFilterTypeDef]], # (1)
sortBy: NotRequired[UsageStatisticsSortByTypeDef], # (2)
timeRange: NotRequired[TimeRangeType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See UsageStatisticsFilterTypeDef
- See UsageStatisticsSortByTypeDef
- See TimeRangeType
- See PaginatorConfigTypeDef
GetUsageStatisticsRequestRequestTypeDef#
# GetUsageStatisticsRequestRequestTypeDef definition
class GetUsageStatisticsRequestRequestTypeDef(TypedDict):
filterBy: NotRequired[Sequence[UsageStatisticsFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[UsageStatisticsSortByTypeDef], # (2)
timeRange: NotRequired[TimeRangeType], # (3)
GetUsageTotalsResponseTypeDef#
# GetUsageTotalsResponseTypeDef definition
class GetUsageTotalsResponseTypeDef(TypedDict):
timeRange: TimeRangeType, # (1)
usageTotals: List[UsageTotalTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See TimeRangeType
- See UsageTotalTypeDef
- See ResponseMetadataTypeDef
IpAddressDetailsTypeDef#
# IpAddressDetailsTypeDef definition
class IpAddressDetailsTypeDef(TypedDict):
ipAddressV4: NotRequired[str],
ipCity: NotRequired[IpCityTypeDef], # (1)
ipCountry: NotRequired[IpCountryTypeDef], # (2)
ipGeoLocation: NotRequired[IpGeoLocationTypeDef], # (3)
ipOwner: NotRequired[IpOwnerTypeDef], # (4)
- See IpCityTypeDef
- See IpCountryTypeDef
- See IpGeoLocationTypeDef
- See IpOwnerTypeDef
JobScheduleFrequencyOutputTypeDef#
# JobScheduleFrequencyOutputTypeDef definition
class JobScheduleFrequencyOutputTypeDef(TypedDict):
dailySchedule: NotRequired[Dict[str, Any]],
monthlySchedule: NotRequired[MonthlyScheduleTypeDef], # (1)
weeklySchedule: NotRequired[WeeklyScheduleTypeDef], # (2)
JobScheduleFrequencyTypeDef#
# JobScheduleFrequencyTypeDef definition
class JobScheduleFrequencyTypeDef(TypedDict):
dailySchedule: NotRequired[Mapping[str, Any]],
monthlySchedule: NotRequired[MonthlyScheduleTypeDef], # (1)
weeklySchedule: NotRequired[WeeklyScheduleTypeDef], # (2)
ListJobsFilterCriteriaTypeDef#
# ListJobsFilterCriteriaTypeDef definition
class ListJobsFilterCriteriaTypeDef(TypedDict):
excludes: NotRequired[Sequence[ListJobsFilterTermTypeDef]], # (1)
includes: NotRequired[Sequence[ListJobsFilterTermTypeDef]], # (1)
ListManagedDataIdentifiersResponseTypeDef#
# ListManagedDataIdentifiersResponseTypeDef definition
class ListManagedDataIdentifiersResponseTypeDef(TypedDict):
items: List[ManagedDataIdentifierSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListMembersResponseTypeDef#
# ListMembersResponseTypeDef definition
class ListMembersResponseTypeDef(TypedDict):
members: List[MemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See MemberTypeDef
- See ResponseMetadataTypeDef
ListResourceProfileArtifactsResponseTypeDef#
# ListResourceProfileArtifactsResponseTypeDef definition
class ListResourceProfileArtifactsResponseTypeDef(TypedDict):
artifacts: List[ResourceProfileArtifactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListSensitivityInspectionTemplatesResponseTypeDef#
# ListSensitivityInspectionTemplatesResponseTypeDef definition
class ListSensitivityInspectionTemplatesResponseTypeDef(TypedDict):
sensitivityInspectionTemplates: List[SensitivityInspectionTemplatesEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
PageTypeDef#
# PageTypeDef definition
class PageTypeDef(TypedDict):
lineRange: NotRequired[RangeTypeDef], # (1)
offsetRange: NotRequired[RangeTypeDef], # (1)
pageNumber: NotRequired[int],
- See RangeTypeDef
- See RangeTypeDef
S3ObjectTypeDef#
# S3ObjectTypeDef definition
class S3ObjectTypeDef(TypedDict):
bucketArn: NotRequired[str],
eTag: NotRequired[str],
extension: NotRequired[str],
key: NotRequired[str],
lastModified: NotRequired[datetime],
path: NotRequired[str],
publicAccess: NotRequired[bool],
serverSideEncryption: NotRequired[ServerSideEncryptionTypeDef], # (1)
size: NotRequired[int],
storageClass: NotRequired[StorageClassType], # (2)
tags: NotRequired[List[KeyValuePairTypeDef]], # (3)
versionId: NotRequired[str],
S3ClassificationScopeTypeDef#
# S3ClassificationScopeTypeDef definition
class S3ClassificationScopeTypeDef(TypedDict):
excludes: S3ClassificationScopeExclusionTypeDef, # (1)
S3ClassificationScopeUpdateTypeDef#
# S3ClassificationScopeUpdateTypeDef definition
class S3ClassificationScopeUpdateTypeDef(TypedDict):
excludes: S3ClassificationScopeExclusionUpdateTypeDef, # (1)
SearchResourcesTagCriterionTypeDef#
# SearchResourcesTagCriterionTypeDef definition
class SearchResourcesTagCriterionTypeDef(TypedDict):
comparator: NotRequired[SearchResourcesComparatorType], # (1)
tagValues: NotRequired[Sequence[SearchResourcesTagCriterionPairTypeDef]], # (2)
UpdateSensitivityInspectionTemplateRequestRequestTypeDef#
# UpdateSensitivityInspectionTemplateRequestRequestTypeDef definition
class UpdateSensitivityInspectionTemplateRequestRequestTypeDef(TypedDict):
id: str,
description: NotRequired[str],
excludes: NotRequired[SensitivityInspectionTemplateExcludesTypeDef], # (1)
includes: NotRequired[SensitivityInspectionTemplateIncludesTypeDef], # (2)
UsageByAccountTypeDef#
# UsageByAccountTypeDef definition
class UsageByAccountTypeDef(TypedDict):
currency: NotRequired[CurrencyType], # (1)
estimatedCost: NotRequired[str],
serviceLimit: NotRequired[ServiceLimitTypeDef], # (2)
type: NotRequired[UsageTypeType], # (3)
- See CurrencyType
- See ServiceLimitTypeDef
- See UsageTypeType
SessionContextTypeDef#
# SessionContextTypeDef definition
class SessionContextTypeDef(TypedDict):
attributes: NotRequired[SessionContextAttributesTypeDef], # (1)
sessionIssuer: NotRequired[SessionIssuerTypeDef], # (2)
UpdateResourceProfileDetectionsRequestRequestTypeDef#
# UpdateResourceProfileDetectionsRequestRequestTypeDef definition
class UpdateResourceProfileDetectionsRequestRequestTypeDef(TypedDict):
resourceArn: str,
suppressDataIdentifiers: NotRequired[Sequence[SuppressDataIdentifierTypeDef]], # (1)
TagCriterionForJobOutputTypeDef#
# TagCriterionForJobOutputTypeDef definition
class TagCriterionForJobOutputTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
tagValues: NotRequired[List[TagCriterionPairForJobTypeDef]], # (2)
TagCriterionForJobTypeDef#
# TagCriterionForJobTypeDef definition
class TagCriterionForJobTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
tagValues: NotRequired[Sequence[TagCriterionPairForJobTypeDef]], # (2)
TagScopeTermOutputTypeDef#
# TagScopeTermOutputTypeDef definition
class TagScopeTermOutputTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[str],
tagValues: NotRequired[List[TagValuePairTypeDef]], # (2)
target: NotRequired[TagTargetType], # (3)
- See JobComparatorType
- See TagValuePairTypeDef
- See TagTargetType
TagScopeTermTypeDef#
# TagScopeTermTypeDef definition
class TagScopeTermTypeDef(TypedDict):
comparator: NotRequired[JobComparatorType], # (1)
key: NotRequired[str],
tagValues: NotRequired[Sequence[TagValuePairTypeDef]], # (2)
target: NotRequired[TagTargetType], # (3)
- See JobComparatorType
- See TagValuePairTypeDef
- See TagTargetType
UpdateRevealConfigurationRequestRequestTypeDef#
# UpdateRevealConfigurationRequestRequestTypeDef definition
class UpdateRevealConfigurationRequestRequestTypeDef(TypedDict):
configuration: RevealConfigurationTypeDef, # (1)
retrievalConfiguration: NotRequired[UpdateRetrievalConfigurationTypeDef], # (2)
CreateAllowListRequestRequestTypeDef#
# CreateAllowListRequestRequestTypeDef definition
class CreateAllowListRequestRequestTypeDef(TypedDict):
clientToken: str,
criteria: AllowListCriteriaTypeDef, # (1)
name: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
GetAllowListResponseTypeDef#
# GetAllowListResponseTypeDef definition
class GetAllowListResponseTypeDef(TypedDict):
arn: str,
createdAt: datetime,
criteria: AllowListCriteriaTypeDef, # (1)
description: str,
id: str,
name: str,
status: AllowListStatusTypeDef, # (2)
tags: Dict[str, str],
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateAllowListRequestRequestTypeDef#
# UpdateAllowListRequestRequestTypeDef definition
class UpdateAllowListRequestRequestTypeDef(TypedDict):
criteria: AllowListCriteriaTypeDef, # (1)
id: str,
name: str,
description: NotRequired[str],
BucketPermissionConfigurationTypeDef#
# BucketPermissionConfigurationTypeDef definition
class BucketPermissionConfigurationTypeDef(TypedDict):
accountLevelPermissions: NotRequired[AccountLevelPermissionsTypeDef], # (1)
bucketLevelPermissions: NotRequired[BucketLevelPermissionsTypeDef], # (2)
MatchingResourceTypeDef#
# MatchingResourceTypeDef definition
class MatchingResourceTypeDef(TypedDict):
matchingBucket: NotRequired[MatchingBucketTypeDef], # (1)
GetBucketStatisticsResponseTypeDef#
# GetBucketStatisticsResponseTypeDef definition
class GetBucketStatisticsResponseTypeDef(TypedDict):
bucketCount: int,
bucketCountByEffectivePermission: BucketCountByEffectivePermissionTypeDef, # (1)
bucketCountByEncryptionType: BucketCountByEncryptionTypeTypeDef, # (2)
bucketCountByObjectEncryptionRequirement: BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef, # (3)
bucketCountBySharedAccessType: BucketCountBySharedAccessTypeTypeDef, # (4)
bucketStatisticsBySensitivity: BucketStatisticsBySensitivityTypeDef, # (5)
classifiableObjectCount: int,
classifiableSizeInBytes: int,
lastUpdated: datetime,
objectCount: int,
sizeInBytes: int,
sizeInBytesCompressed: int,
unclassifiableObjectCount: ObjectLevelStatisticsTypeDef, # (6)
unclassifiableObjectSizeInBytes: ObjectLevelStatisticsTypeDef, # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (8)
- See BucketCountByEffectivePermissionTypeDef
- See BucketCountByEncryptionTypeTypeDef
- See BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef
- See BucketCountBySharedAccessTypeTypeDef
- See BucketStatisticsBySensitivityTypeDef
- See ObjectLevelStatisticsTypeDef
- See ObjectLevelStatisticsTypeDef
- See ResponseMetadataTypeDef
GetClassificationExportConfigurationResponseTypeDef#
# GetClassificationExportConfigurationResponseTypeDef definition
class GetClassificationExportConfigurationResponseTypeDef(TypedDict):
configuration: ClassificationExportConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutClassificationExportConfigurationRequestRequestTypeDef#
# PutClassificationExportConfigurationRequestRequestTypeDef definition
class PutClassificationExportConfigurationRequestRequestTypeDef(TypedDict):
configuration: ClassificationExportConfigurationTypeDef, # (1)
PutClassificationExportConfigurationResponseTypeDef#
# PutClassificationExportConfigurationResponseTypeDef definition
class PutClassificationExportConfigurationResponseTypeDef(TypedDict):
configuration: ClassificationExportConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFindingsFilterResponseTypeDef#
# GetFindingsFilterResponseTypeDef definition
class GetFindingsFilterResponseTypeDef(TypedDict):
action: FindingsFilterActionType, # (1)
arn: str,
description: str,
findingCriteria: FindingCriteriaOutputTypeDef, # (2)
id: str,
name: str,
position: int,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (3)
FindingCriteriaTypeDef#
# FindingCriteriaTypeDef definition
class FindingCriteriaTypeDef(TypedDict):
criterion: NotRequired[Mapping[str, CriterionAdditionalPropertiesUnionTypeDef]], # (1)
ListClassificationJobsRequestListClassificationJobsPaginateTypeDef#
# ListClassificationJobsRequestListClassificationJobsPaginateTypeDef definition
class ListClassificationJobsRequestListClassificationJobsPaginateTypeDef(TypedDict):
filterCriteria: NotRequired[ListJobsFilterCriteriaTypeDef], # (1)
sortCriteria: NotRequired[ListJobsSortCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListClassificationJobsRequestRequestTypeDef#
# ListClassificationJobsRequestRequestTypeDef definition
class ListClassificationJobsRequestRequestTypeDef(TypedDict):
filterCriteria: NotRequired[ListJobsFilterCriteriaTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortCriteria: NotRequired[ListJobsSortCriteriaTypeDef], # (2)
OccurrencesTypeDef#
# OccurrencesTypeDef definition
class OccurrencesTypeDef(TypedDict):
cells: NotRequired[List[CellTypeDef]], # (1)
lineRanges: NotRequired[List[RangeTypeDef]], # (2)
offsetRanges: NotRequired[List[RangeTypeDef]], # (2)
pages: NotRequired[List[PageTypeDef]], # (4)
records: NotRequired[List[RecordTypeDef]], # (5)
- See CellTypeDef
- See RangeTypeDef
- See RangeTypeDef
- See PageTypeDef
- See RecordTypeDef
GetClassificationScopeResponseTypeDef#
# GetClassificationScopeResponseTypeDef definition
class GetClassificationScopeResponseTypeDef(TypedDict):
id: str,
name: str,
s3: S3ClassificationScopeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateClassificationScopeRequestRequestTypeDef#
# UpdateClassificationScopeRequestRequestTypeDef definition
class UpdateClassificationScopeRequestRequestTypeDef(TypedDict):
id: str,
s3: NotRequired[S3ClassificationScopeUpdateTypeDef], # (1)
SearchResourcesCriteriaTypeDef#
# SearchResourcesCriteriaTypeDef definition
class SearchResourcesCriteriaTypeDef(TypedDict):
simpleCriterion: NotRequired[SearchResourcesSimpleCriterionTypeDef], # (1)
tagCriterion: NotRequired[SearchResourcesTagCriterionTypeDef], # (2)
UsageRecordTypeDef#
# UsageRecordTypeDef definition
class UsageRecordTypeDef(TypedDict):
accountId: NotRequired[str],
automatedDiscoveryFreeTrialStartDate: NotRequired[datetime],
freeTrialStartDate: NotRequired[datetime],
usage: NotRequired[List[UsageByAccountTypeDef]], # (1)
AssumedRoleTypeDef#
# AssumedRoleTypeDef definition
class AssumedRoleTypeDef(TypedDict):
accessKeyId: NotRequired[str],
accountId: NotRequired[str],
arn: NotRequired[str],
principalId: NotRequired[str],
sessionContext: NotRequired[SessionContextTypeDef], # (1)
FederatedUserTypeDef#
# FederatedUserTypeDef definition
class FederatedUserTypeDef(TypedDict):
accessKeyId: NotRequired[str],
accountId: NotRequired[str],
arn: NotRequired[str],
principalId: NotRequired[str],
sessionContext: NotRequired[SessionContextTypeDef], # (1)
CriteriaForJobOutputTypeDef#
# CriteriaForJobOutputTypeDef definition
class CriteriaForJobOutputTypeDef(TypedDict):
simpleCriterion: NotRequired[SimpleCriterionForJobOutputTypeDef], # (1)
tagCriterion: NotRequired[TagCriterionForJobOutputTypeDef], # (2)
JobScopeTermOutputTypeDef#
# JobScopeTermOutputTypeDef definition
class JobScopeTermOutputTypeDef(TypedDict):
simpleScopeTerm: NotRequired[SimpleScopeTermOutputTypeDef], # (1)
tagScopeTerm: NotRequired[TagScopeTermOutputTypeDef], # (2)
BucketPublicAccessTypeDef#
# BucketPublicAccessTypeDef definition
class BucketPublicAccessTypeDef(TypedDict):
effectivePermission: NotRequired[EffectivePermissionType], # (1)
permissionConfiguration: NotRequired[BucketPermissionConfigurationTypeDef], # (2)
SearchResourcesResponseTypeDef#
# SearchResourcesResponseTypeDef definition
class SearchResourcesResponseTypeDef(TypedDict):
matchingResources: List[MatchingResourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CreateFindingsFilterRequestRequestTypeDef#
# CreateFindingsFilterRequestRequestTypeDef definition
class CreateFindingsFilterRequestRequestTypeDef(TypedDict):
action: FindingsFilterActionType, # (1)
findingCriteria: FindingCriteriaTypeDef, # (2)
name: str,
clientToken: NotRequired[str],
description: NotRequired[str],
position: NotRequired[int],
tags: NotRequired[Mapping[str, str]],
GetFindingStatisticsRequestRequestTypeDef#
# GetFindingStatisticsRequestRequestTypeDef definition
class GetFindingStatisticsRequestRequestTypeDef(TypedDict):
groupBy: GroupByType, # (1)
findingCriteria: NotRequired[FindingCriteriaTypeDef], # (2)
size: NotRequired[int],
sortCriteria: NotRequired[FindingStatisticsSortCriteriaTypeDef], # (3)
ListFindingsRequestListFindingsPaginateTypeDef#
# ListFindingsRequestListFindingsPaginateTypeDef definition
class ListFindingsRequestListFindingsPaginateTypeDef(TypedDict):
findingCriteria: NotRequired[FindingCriteriaTypeDef], # (1)
sortCriteria: NotRequired[SortCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListFindingsRequestRequestTypeDef#
# ListFindingsRequestRequestTypeDef definition
class ListFindingsRequestRequestTypeDef(TypedDict):
findingCriteria: NotRequired[FindingCriteriaTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortCriteria: NotRequired[SortCriteriaTypeDef], # (2)
UpdateFindingsFilterRequestRequestTypeDef#
# UpdateFindingsFilterRequestRequestTypeDef definition
class UpdateFindingsFilterRequestRequestTypeDef(TypedDict):
id: str,
action: NotRequired[FindingsFilterActionType], # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
findingCriteria: NotRequired[FindingCriteriaTypeDef], # (2)
name: NotRequired[str],
position: NotRequired[int],
CustomDetectionTypeDef#
# CustomDetectionTypeDef definition
class CustomDetectionTypeDef(TypedDict):
arn: NotRequired[str],
count: NotRequired[int],
name: NotRequired[str],
occurrences: NotRequired[OccurrencesTypeDef], # (1)
DefaultDetectionTypeDef#
# DefaultDetectionTypeDef definition
class DefaultDetectionTypeDef(TypedDict):
count: NotRequired[int],
occurrences: NotRequired[OccurrencesTypeDef], # (1)
type: NotRequired[str],
SearchResourcesCriteriaBlockTypeDef#
# SearchResourcesCriteriaBlockTypeDef definition
class SearchResourcesCriteriaBlockTypeDef(TypedDict):
and: NotRequired[Sequence[SearchResourcesCriteriaTypeDef]], # (1)
GetUsageStatisticsResponseTypeDef#
# GetUsageStatisticsResponseTypeDef definition
class GetUsageStatisticsResponseTypeDef(TypedDict):
records: List[UsageRecordTypeDef], # (1)
timeRange: TimeRangeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
nextToken: NotRequired[str],
- See UsageRecordTypeDef
- See TimeRangeType
- See ResponseMetadataTypeDef
UserIdentityTypeDef#
# UserIdentityTypeDef definition
class UserIdentityTypeDef(TypedDict):
assumedRole: NotRequired[AssumedRoleTypeDef], # (1)
awsAccount: NotRequired[AwsAccountTypeDef], # (2)
awsService: NotRequired[AwsServiceTypeDef], # (3)
federatedUser: NotRequired[FederatedUserTypeDef], # (4)
iamUser: NotRequired[IamUserTypeDef], # (5)
root: NotRequired[UserIdentityRootTypeDef], # (6)
type: NotRequired[UserIdentityTypeType], # (7)
- See AssumedRoleTypeDef
- See AwsAccountTypeDef
- See AwsServiceTypeDef
- See FederatedUserTypeDef
- See IamUserTypeDef
- See UserIdentityRootTypeDef
- See UserIdentityTypeType
CriteriaBlockForJobOutputTypeDef#
# CriteriaBlockForJobOutputTypeDef definition
class CriteriaBlockForJobOutputTypeDef(TypedDict):
and: NotRequired[List[CriteriaForJobOutputTypeDef]], # (1)
CriteriaForJobTypeDef#
# CriteriaForJobTypeDef definition
class CriteriaForJobTypeDef(TypedDict):
simpleCriterion: NotRequired[SimpleCriterionForJobUnionTypeDef], # (1)
tagCriterion: NotRequired[TagCriterionForJobUnionTypeDef], # (2)
- See SimpleCriterionForJobTypeDef SimpleCriterionForJobOutputTypeDef
- See TagCriterionForJobTypeDef TagCriterionForJobOutputTypeDef
JobScopingBlockOutputTypeDef#
# JobScopingBlockOutputTypeDef definition
class JobScopingBlockOutputTypeDef(TypedDict):
and: NotRequired[List[JobScopeTermOutputTypeDef]], # (1)
JobScopeTermTypeDef#
# JobScopeTermTypeDef definition
class JobScopeTermTypeDef(TypedDict):
simpleScopeTerm: NotRequired[SimpleScopeTermUnionTypeDef], # (1)
tagScopeTerm: NotRequired[TagScopeTermUnionTypeDef], # (2)
- See SimpleScopeTermTypeDef SimpleScopeTermOutputTypeDef
- See TagScopeTermTypeDef TagScopeTermOutputTypeDef
BucketMetadataTypeDef#
# BucketMetadataTypeDef definition
class BucketMetadataTypeDef(TypedDict):
accountId: NotRequired[str],
allowsUnencryptedObjectUploads: NotRequired[AllowsUnencryptedObjectUploadsType], # (1)
automatedDiscoveryMonitoringStatus: NotRequired[AutomatedDiscoveryMonitoringStatusType], # (2)
bucketArn: NotRequired[str],
bucketCreatedAt: NotRequired[datetime],
bucketName: NotRequired[str],
classifiableObjectCount: NotRequired[int],
classifiableSizeInBytes: NotRequired[int],
errorCode: NotRequired[BucketMetadataErrorCodeType], # (3)
errorMessage: NotRequired[str],
jobDetails: NotRequired[JobDetailsTypeDef], # (4)
lastAutomatedDiscoveryTime: NotRequired[datetime],
lastUpdated: NotRequired[datetime],
objectCount: NotRequired[int],
objectCountByEncryptionType: NotRequired[ObjectCountByEncryptionTypeTypeDef], # (5)
publicAccess: NotRequired[BucketPublicAccessTypeDef], # (6)
region: NotRequired[str],
replicationDetails: NotRequired[ReplicationDetailsTypeDef], # (7)
sensitivityScore: NotRequired[int],
serverSideEncryption: NotRequired[BucketServerSideEncryptionTypeDef], # (8)
sharedAccess: NotRequired[SharedAccessType], # (9)
sizeInBytes: NotRequired[int],
sizeInBytesCompressed: NotRequired[int],
tags: NotRequired[List[KeyValuePairTypeDef]], # (10)
unclassifiableObjectCount: NotRequired[ObjectLevelStatisticsTypeDef], # (11)
unclassifiableObjectSizeInBytes: NotRequired[ObjectLevelStatisticsTypeDef], # (11)
versioning: NotRequired[bool],
- See AllowsUnencryptedObjectUploadsType
- See AutomatedDiscoveryMonitoringStatusType
- See BucketMetadataErrorCodeType
- See JobDetailsTypeDef
- See ObjectCountByEncryptionTypeTypeDef
- See BucketPublicAccessTypeDef
- See ReplicationDetailsTypeDef
- See BucketServerSideEncryptionTypeDef
- See SharedAccessType
- See KeyValuePairTypeDef
- See ObjectLevelStatisticsTypeDef
- See ObjectLevelStatisticsTypeDef
S3BucketTypeDef#
# S3BucketTypeDef definition
class S3BucketTypeDef(TypedDict):
allowsUnencryptedObjectUploads: NotRequired[AllowsUnencryptedObjectUploadsType], # (1)
arn: NotRequired[str],
createdAt: NotRequired[datetime],
defaultServerSideEncryption: NotRequired[ServerSideEncryptionTypeDef], # (2)
name: NotRequired[str],
owner: NotRequired[S3BucketOwnerTypeDef], # (3)
publicAccess: NotRequired[BucketPublicAccessTypeDef], # (4)
tags: NotRequired[List[KeyValuePairTypeDef]], # (5)
- See AllowsUnencryptedObjectUploadsType
- See ServerSideEncryptionTypeDef
- See S3BucketOwnerTypeDef
- See BucketPublicAccessTypeDef
- See KeyValuePairTypeDef
CustomDataIdentifiersTypeDef#
# CustomDataIdentifiersTypeDef definition
class CustomDataIdentifiersTypeDef(TypedDict):
detections: NotRequired[List[CustomDetectionTypeDef]], # (1)
totalCount: NotRequired[int],
SensitiveDataItemTypeDef#
# SensitiveDataItemTypeDef definition
class SensitiveDataItemTypeDef(TypedDict):
category: NotRequired[SensitiveDataItemCategoryType], # (1)
detections: NotRequired[List[DefaultDetectionTypeDef]], # (2)
totalCount: NotRequired[int],
SearchResourcesBucketCriteriaTypeDef#
# SearchResourcesBucketCriteriaTypeDef definition
class SearchResourcesBucketCriteriaTypeDef(TypedDict):
excludes: NotRequired[SearchResourcesCriteriaBlockTypeDef], # (1)
includes: NotRequired[SearchResourcesCriteriaBlockTypeDef], # (1)
FindingActorTypeDef#
# FindingActorTypeDef definition
class FindingActorTypeDef(TypedDict):
domainDetails: NotRequired[DomainDetailsTypeDef], # (1)
ipAddressDetails: NotRequired[IpAddressDetailsTypeDef], # (2)
userIdentity: NotRequired[UserIdentityTypeDef], # (3)
S3BucketCriteriaForJobOutputTypeDef#
# S3BucketCriteriaForJobOutputTypeDef definition
class S3BucketCriteriaForJobOutputTypeDef(TypedDict):
excludes: NotRequired[CriteriaBlockForJobOutputTypeDef], # (1)
includes: NotRequired[CriteriaBlockForJobOutputTypeDef], # (1)
ScopingOutputTypeDef#
# ScopingOutputTypeDef definition
class ScopingOutputTypeDef(TypedDict):
excludes: NotRequired[JobScopingBlockOutputTypeDef], # (1)
includes: NotRequired[JobScopingBlockOutputTypeDef], # (1)
DescribeBucketsResponseTypeDef#
# DescribeBucketsResponseTypeDef definition
class DescribeBucketsResponseTypeDef(TypedDict):
buckets: List[BucketMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ResourcesAffectedTypeDef#
# ResourcesAffectedTypeDef definition
class ResourcesAffectedTypeDef(TypedDict):
s3Bucket: NotRequired[S3BucketTypeDef], # (1)
s3Object: NotRequired[S3ObjectTypeDef], # (2)
- See S3BucketTypeDef
- See S3ObjectTypeDef
ClassificationResultTypeDef#
# ClassificationResultTypeDef definition
class ClassificationResultTypeDef(TypedDict):
additionalOccurrences: NotRequired[bool],
customDataIdentifiers: NotRequired[CustomDataIdentifiersTypeDef], # (1)
mimeType: NotRequired[str],
sensitiveData: NotRequired[List[SensitiveDataItemTypeDef]], # (2)
sizeClassified: NotRequired[int],
status: NotRequired[ClassificationResultStatusTypeDef], # (3)
SearchResourcesRequestRequestTypeDef#
# SearchResourcesRequestRequestTypeDef definition
class SearchResourcesRequestRequestTypeDef(TypedDict):
bucketCriteria: NotRequired[SearchResourcesBucketCriteriaTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortCriteria: NotRequired[SearchResourcesSortCriteriaTypeDef], # (2)
SearchResourcesRequestSearchResourcesPaginateTypeDef#
# SearchResourcesRequestSearchResourcesPaginateTypeDef definition
class SearchResourcesRequestSearchResourcesPaginateTypeDef(TypedDict):
bucketCriteria: NotRequired[SearchResourcesBucketCriteriaTypeDef], # (1)
sortCriteria: NotRequired[SearchResourcesSortCriteriaTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SearchResourcesBucketCriteriaTypeDef
- See SearchResourcesSortCriteriaTypeDef
- See PaginatorConfigTypeDef
PolicyDetailsTypeDef#
# PolicyDetailsTypeDef definition
class PolicyDetailsTypeDef(TypedDict):
action: NotRequired[FindingActionTypeDef], # (1)
actor: NotRequired[FindingActorTypeDef], # (2)
JobSummaryTypeDef#
# JobSummaryTypeDef definition
class JobSummaryTypeDef(TypedDict):
bucketCriteria: NotRequired[S3BucketCriteriaForJobOutputTypeDef], # (1)
bucketDefinitions: NotRequired[List[S3BucketDefinitionForJobOutputTypeDef]], # (2)
createdAt: NotRequired[datetime],
jobId: NotRequired[str],
jobStatus: NotRequired[JobStatusType], # (3)
jobType: NotRequired[JobTypeType], # (4)
lastRunErrorStatus: NotRequired[LastRunErrorStatusTypeDef], # (5)
name: NotRequired[str],
userPausedDetails: NotRequired[UserPausedDetailsTypeDef], # (6)
- See S3BucketCriteriaForJobOutputTypeDef
- See S3BucketDefinitionForJobOutputTypeDef
- See JobStatusType
- See JobTypeType
- See LastRunErrorStatusTypeDef
- See UserPausedDetailsTypeDef
CriteriaBlockForJobTypeDef#
# CriteriaBlockForJobTypeDef definition
class CriteriaBlockForJobTypeDef(TypedDict):
and: NotRequired[Sequence[CriteriaForJobUnionTypeDef]], # (1)
S3JobDefinitionOutputTypeDef#
# S3JobDefinitionOutputTypeDef definition
class S3JobDefinitionOutputTypeDef(TypedDict):
bucketCriteria: NotRequired[S3BucketCriteriaForJobOutputTypeDef], # (1)
bucketDefinitions: NotRequired[List[S3BucketDefinitionForJobOutputTypeDef]], # (2)
scoping: NotRequired[ScopingOutputTypeDef], # (3)
- See S3BucketCriteriaForJobOutputTypeDef
- See S3BucketDefinitionForJobOutputTypeDef
- See ScopingOutputTypeDef
JobScopingBlockTypeDef#
# JobScopingBlockTypeDef definition
class JobScopingBlockTypeDef(TypedDict):
and: NotRequired[Sequence[JobScopeTermUnionTypeDef]], # (1)
ClassificationDetailsTypeDef#
# ClassificationDetailsTypeDef definition
class ClassificationDetailsTypeDef(TypedDict):
detailedResultsLocation: NotRequired[str],
jobArn: NotRequired[str],
jobId: NotRequired[str],
originType: NotRequired[OriginTypeType], # (1)
result: NotRequired[ClassificationResultTypeDef], # (2)
ListClassificationJobsResponseTypeDef#
# ListClassificationJobsResponseTypeDef definition
class ListClassificationJobsResponseTypeDef(TypedDict):
items: List[JobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
DescribeClassificationJobResponseTypeDef#
# DescribeClassificationJobResponseTypeDef definition
class DescribeClassificationJobResponseTypeDef(TypedDict):
allowListIds: List[str],
clientToken: str,
createdAt: datetime,
customDataIdentifierIds: List[str],
description: str,
initialRun: bool,
jobArn: str,
jobId: str,
jobStatus: JobStatusType, # (1)
jobType: JobTypeType, # (2)
lastRunErrorStatus: LastRunErrorStatusTypeDef, # (3)
lastRunTime: datetime,
managedDataIdentifierIds: List[str],
managedDataIdentifierSelector: ManagedDataIdentifierSelectorType, # (4)
name: str,
s3JobDefinition: S3JobDefinitionOutputTypeDef, # (5)
samplingPercentage: int,
scheduleFrequency: JobScheduleFrequencyOutputTypeDef, # (6)
statistics: StatisticsTypeDef, # (7)
tags: Dict[str, str],
userPausedDetails: UserPausedDetailsTypeDef, # (8)
ResponseMetadata: ResponseMetadataTypeDef, # (9)
- See JobStatusType
- See JobTypeType
- See LastRunErrorStatusTypeDef
- See ManagedDataIdentifierSelectorType
- See S3JobDefinitionOutputTypeDef
- See JobScheduleFrequencyOutputTypeDef
- See StatisticsTypeDef
- See UserPausedDetailsTypeDef
- See ResponseMetadataTypeDef
FindingTypeDef#
# FindingTypeDef definition
class FindingTypeDef(TypedDict):
accountId: NotRequired[str],
archived: NotRequired[bool],
category: NotRequired[FindingCategoryType], # (1)
classificationDetails: NotRequired[ClassificationDetailsTypeDef], # (2)
count: NotRequired[int],
createdAt: NotRequired[datetime],
description: NotRequired[str],
id: NotRequired[str],
partition: NotRequired[str],
policyDetails: NotRequired[PolicyDetailsTypeDef], # (3)
region: NotRequired[str],
resourcesAffected: NotRequired[ResourcesAffectedTypeDef], # (4)
sample: NotRequired[bool],
schemaVersion: NotRequired[str],
severity: NotRequired[SeverityTypeDef], # (5)
title: NotRequired[str],
type: NotRequired[FindingTypeType], # (6)
updatedAt: NotRequired[datetime],
- See FindingCategoryType
- See ClassificationDetailsTypeDef
- See PolicyDetailsTypeDef
- See ResourcesAffectedTypeDef
- See SeverityTypeDef
- See FindingTypeType
S3BucketCriteriaForJobTypeDef#
# S3BucketCriteriaForJobTypeDef definition
class S3BucketCriteriaForJobTypeDef(TypedDict):
excludes: NotRequired[CriteriaBlockForJobUnionTypeDef], # (1)
includes: NotRequired[CriteriaBlockForJobUnionTypeDef], # (1)
- See CriteriaBlockForJobTypeDef CriteriaBlockForJobOutputTypeDef
- See CriteriaBlockForJobTypeDef CriteriaBlockForJobOutputTypeDef
ScopingTypeDef#
# ScopingTypeDef definition
class ScopingTypeDef(TypedDict):
excludes: NotRequired[JobScopingBlockUnionTypeDef], # (1)
includes: NotRequired[JobScopingBlockUnionTypeDef], # (1)
- See JobScopingBlockTypeDef JobScopingBlockOutputTypeDef
- See JobScopingBlockTypeDef JobScopingBlockOutputTypeDef
GetFindingsResponseTypeDef#
# GetFindingsResponseTypeDef definition
class GetFindingsResponseTypeDef(TypedDict):
findings: List[FindingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
S3JobDefinitionTypeDef#
# S3JobDefinitionTypeDef definition
class S3JobDefinitionTypeDef(TypedDict):
bucketCriteria: NotRequired[S3BucketCriteriaForJobUnionTypeDef], # (1)
bucketDefinitions: NotRequired[Sequence[S3BucketDefinitionForJobUnionTypeDef]], # (2)
scoping: NotRequired[ScopingUnionTypeDef], # (3)
- See S3BucketCriteriaForJobTypeDef S3BucketCriteriaForJobOutputTypeDef
- See S3BucketDefinitionForJobTypeDef S3BucketDefinitionForJobOutputTypeDef
- See ScopingTypeDef ScopingOutputTypeDef
CreateClassificationJobRequestRequestTypeDef#
# CreateClassificationJobRequestRequestTypeDef definition
class CreateClassificationJobRequestRequestTypeDef(TypedDict):
clientToken: str,
jobType: JobTypeType, # (1)
name: str,
s3JobDefinition: S3JobDefinitionTypeDef, # (2)
allowListIds: NotRequired[Sequence[str]],
customDataIdentifierIds: NotRequired[Sequence[str]],
description: NotRequired[str],
initialRun: NotRequired[bool],
managedDataIdentifierIds: NotRequired[Sequence[str]],
managedDataIdentifierSelector: NotRequired[ManagedDataIdentifierSelectorType], # (3)
samplingPercentage: NotRequired[int],
scheduleFrequency: NotRequired[JobScheduleFrequencyTypeDef], # (4)
tags: NotRequired[Mapping[str, str]],