Skip to content

Type definitions#

Index > Macie2 > Type definitions

Auto-generated documentation for Macie2 type annotations stubs module mypy-boto3-macie2.

CriterionAdditionalPropertiesUnionTypeDef#

# CriterionAdditionalPropertiesUnionTypeDef definition

CriterionAdditionalPropertiesUnionTypeDef = Union[
    CriterionAdditionalPropertiesTypeDef,  # (1)
    CriterionAdditionalPropertiesOutputTypeDef,  # (2)
]
  1. See CriterionAdditionalPropertiesTypeDef
  2. See CriterionAdditionalPropertiesOutputTypeDef

S3BucketDefinitionForJobUnionTypeDef#

# S3BucketDefinitionForJobUnionTypeDef definition

S3BucketDefinitionForJobUnionTypeDef = Union[
    S3BucketDefinitionForJobTypeDef,  # (1)
    S3BucketDefinitionForJobOutputTypeDef,  # (2)
]
  1. See S3BucketDefinitionForJobTypeDef
  2. See S3BucketDefinitionForJobOutputTypeDef

SimpleCriterionForJobUnionTypeDef#

# SimpleCriterionForJobUnionTypeDef definition

SimpleCriterionForJobUnionTypeDef = Union[
    SimpleCriterionForJobTypeDef,  # (1)
    SimpleCriterionForJobOutputTypeDef,  # (2)
]
  1. See SimpleCriterionForJobTypeDef
  2. See SimpleCriterionForJobOutputTypeDef

SimpleScopeTermUnionTypeDef#

# SimpleScopeTermUnionTypeDef definition

SimpleScopeTermUnionTypeDef = Union[
    SimpleScopeTermTypeDef,  # (1)
    SimpleScopeTermOutputTypeDef,  # (2)
]
  1. See SimpleScopeTermTypeDef
  2. See SimpleScopeTermOutputTypeDef

TagCriterionForJobUnionTypeDef#

# TagCriterionForJobUnionTypeDef definition

TagCriterionForJobUnionTypeDef = Union[
    TagCriterionForJobTypeDef,  # (1)
    TagCriterionForJobOutputTypeDef,  # (2)
]
  1. See TagCriterionForJobTypeDef
  2. See TagCriterionForJobOutputTypeDef

TagScopeTermUnionTypeDef#

# TagScopeTermUnionTypeDef definition

TagScopeTermUnionTypeDef = Union[
    TagScopeTermTypeDef,  # (1)
    TagScopeTermOutputTypeDef,  # (2)
]
  1. See TagScopeTermTypeDef
  2. See TagScopeTermOutputTypeDef

CriteriaForJobUnionTypeDef#

# CriteriaForJobUnionTypeDef definition

CriteriaForJobUnionTypeDef = Union[
    CriteriaForJobTypeDef,  # (1)
    CriteriaForJobOutputTypeDef,  # (2)
]
  1. See CriteriaForJobTypeDef
  2. See CriteriaForJobOutputTypeDef

JobScopeTermUnionTypeDef#

# JobScopeTermUnionTypeDef definition

JobScopeTermUnionTypeDef = Union[
    JobScopeTermTypeDef,  # (1)
    JobScopeTermOutputTypeDef,  # (2)
]
  1. See JobScopeTermTypeDef
  2. See JobScopeTermOutputTypeDef

CriteriaBlockForJobUnionTypeDef#

# CriteriaBlockForJobUnionTypeDef definition

CriteriaBlockForJobUnionTypeDef = Union[
    CriteriaBlockForJobTypeDef,  # (1)
    CriteriaBlockForJobOutputTypeDef,  # (2)
]
  1. See CriteriaBlockForJobTypeDef
  2. See CriteriaBlockForJobOutputTypeDef

JobScopingBlockUnionTypeDef#

# JobScopingBlockUnionTypeDef definition

JobScopingBlockUnionTypeDef = Union[
    JobScopingBlockTypeDef,  # (1)
    JobScopingBlockOutputTypeDef,  # (2)
]
  1. See JobScopingBlockTypeDef
  2. See JobScopingBlockOutputTypeDef

S3BucketCriteriaForJobUnionTypeDef#

# S3BucketCriteriaForJobUnionTypeDef definition

S3BucketCriteriaForJobUnionTypeDef = Union[
    S3BucketCriteriaForJobTypeDef,  # (1)
    S3BucketCriteriaForJobOutputTypeDef,  # (2)
]
  1. See S3BucketCriteriaForJobTypeDef
  2. See S3BucketCriteriaForJobOutputTypeDef

ScopingUnionTypeDef#

# ScopingUnionTypeDef definition

ScopingUnionTypeDef = Union[
    ScopingTypeDef,  # (1)
    ScopingOutputTypeDef,  # (2)
]
  1. See ScopingTypeDef
  2. 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)
  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],
  1. See AllowListStatusCodeType

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)
  1. See AutomatedDiscoveryAccountStatusType

AutomatedDiscoveryAccountUpdateErrorTypeDef#

# AutomatedDiscoveryAccountUpdateErrorTypeDef definition

class AutomatedDiscoveryAccountUpdateErrorTypeDef(TypedDict):
    accountId: NotRequired[str],
    errorCode: NotRequired[AutomatedDiscoveryAccountUpdateErrorCodeType],  # (1)
  1. See AutomatedDiscoveryAccountUpdateErrorCodeType

AutomatedDiscoveryAccountUpdateTypeDef#

# AutomatedDiscoveryAccountUpdateTypeDef definition

class AutomatedDiscoveryAccountUpdateTypeDef(TypedDict):
    accountId: NotRequired[str],
    status: NotRequired[AutomatedDiscoveryAccountStatusType],  # (1)
  1. See AutomatedDiscoveryAccountStatusType

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)
  1. See TypeType

JobDetailsTypeDef#

# JobDetailsTypeDef definition

class JobDetailsTypeDef(TypedDict):
    isDefinedInJob: NotRequired[IsDefinedInJobType],  # (1)
    isMonitoredByJob: NotRequired[IsMonitoredByJobType],  # (2)
    lastJobId: NotRequired[str],
    lastJobRunTime: NotRequired[datetime],
  1. See IsDefinedInJobType
  2. See IsMonitoredByJobType

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)
  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)
  1. See DataIdentifierSeverityType

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],
  1. See ErrorCodeType

CreateSampleFindingsRequestRequestTypeDef#

# CreateSampleFindingsRequestRequestTypeDef definition

class CreateSampleFindingsRequestRequestTypeDef(TypedDict):
    findingTypes: NotRequired[Sequence[FindingTypeType]],  # (1)
  1. See FindingTypeType

SimpleCriterionForJobOutputTypeDef#

# SimpleCriterionForJobOutputTypeDef definition

class SimpleCriterionForJobOutputTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    key: NotRequired[SimpleCriterionKeyForJobType],  # (2)
    values: NotRequired[list[str]],
  1. See JobComparatorType
  2. See SimpleCriterionKeyForJobType

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)
  1. See LastRunErrorStatusCodeType

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)
  1. See DataIdentifierTypeType

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)
  1. See FindingPublishingFrequencyType
  2. See MacieStatusType

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)
  1. See FindingStatisticsSortAttributeNameType
  2. See OrderByType

SeverityTypeDef#

# SeverityTypeDef definition

class SeverityTypeDef(TypedDict):
    description: NotRequired[SeverityDescriptionType],  # (1)
    score: NotRequired[int],
  1. See SeverityDescriptionType

FindingsFilterListItemTypeDef#

# FindingsFilterListItemTypeDef definition

class FindingsFilterListItemTypeDef(TypedDict):
    action: NotRequired[FindingsFilterActionType],  # (1)
    arn: NotRequired[str],
    id: NotRequired[str],
    name: NotRequired[str],
    tags: NotRequired[dict[str, str]],
  1. See FindingsFilterActionType

InvitationTypeDef#

# InvitationTypeDef definition

class InvitationTypeDef(TypedDict):
    accountId: NotRequired[str],
    invitationId: NotRequired[str],
    invitedAt: NotRequired[datetime],
    relationshipStatus: NotRequired[RelationshipStatusType],  # (1)
  1. See RelationshipStatusType

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)
  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],
  1. See RetrievalModeType

RevealConfigurationTypeDef#

# RevealConfigurationTypeDef definition

class RevealConfigurationTypeDef(TypedDict):
    status: RevealStatusType,  # (1)
    kmsKeyId: NotRequired[str],
  1. See RevealStatusType

GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef#

# GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef definition

class GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef(TypedDict):
    findingId: str,

GetSensitiveDataOccurrencesRequestRequestTypeDef#

# GetSensitiveDataOccurrencesRequestRequestTypeDef definition

class GetSensitiveDataOccurrencesRequestRequestTypeDef(TypedDict):
    findingId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

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]],
  1. See UsageStatisticsFilterComparatorType
  2. See UsageStatisticsFilterKeyType

UsageStatisticsSortByTypeDef#

# UsageStatisticsSortByTypeDef definition

class UsageStatisticsSortByTypeDef(TypedDict):
    key: NotRequired[UsageStatisticsSortKeyType],  # (1)
    orderBy: NotRequired[OrderByType],  # (2)
  1. See UsageStatisticsSortKeyType
  2. See OrderByType

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)
  1. See CurrencyType
  2. 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)
  1. See DayOfWeekType

SimpleScopeTermOutputTypeDef#

# SimpleScopeTermOutputTypeDef definition

class SimpleScopeTermOutputTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    key: NotRequired[ScopeFilterKeyType],  # (2)
    values: NotRequired[list[str]],
  1. See JobComparatorType
  2. 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)
  1. See ListJobsSortAttributeNameType
  2. See OrderByType

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]],
  1. See JobComparatorType
  2. See ListJobsFilterKeyType

ListManagedDataIdentifiersRequestRequestTypeDef#

# ListManagedDataIdentifiersRequestRequestTypeDef definition

class ListManagedDataIdentifiersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

ManagedDataIdentifierSummaryTypeDef#

# ManagedDataIdentifierSummaryTypeDef definition

class ManagedDataIdentifierSummaryTypeDef(TypedDict):
    category: NotRequired[SensitiveDataItemCategoryType],  # (1)
    id: NotRequired[str],
  1. See SensitiveDataItemCategoryType

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],
  1. See RelationshipStatusType

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],
  1. See EncryptionTypeType

S3ClassificationScopeExclusionTypeDef#

# S3ClassificationScopeExclusionTypeDef definition

class S3ClassificationScopeExclusionTypeDef(TypedDict):
    bucketNames: list[str],

S3ClassificationScopeExclusionUpdateTypeDef#

# S3ClassificationScopeExclusionUpdateTypeDef definition

class S3ClassificationScopeExclusionUpdateTypeDef(TypedDict):
    bucketNames: Sequence[str],
    operation: ClassificationScopeUpdateOperationType,  # (1)
  1. See ClassificationScopeUpdateOperationType

SearchResourcesSimpleCriterionTypeDef#

# SearchResourcesSimpleCriterionTypeDef definition

class SearchResourcesSimpleCriterionTypeDef(TypedDict):
    comparator: NotRequired[SearchResourcesComparatorType],  # (1)
    key: NotRequired[SearchResourcesSimpleCriterionKeyType],  # (2)
    values: NotRequired[Sequence[str]],
  1. See SearchResourcesComparatorType
  2. See SearchResourcesSimpleCriterionKeyType

SearchResourcesSortCriteriaTypeDef#

# SearchResourcesSortCriteriaTypeDef definition

class SearchResourcesSortCriteriaTypeDef(TypedDict):
    attributeName: NotRequired[SearchResourcesSortAttributeNameType],  # (1)
    orderBy: NotRequired[OrderByType],  # (2)
  1. See SearchResourcesSortAttributeNameType
  2. See OrderByType

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],
  1. 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]],
  1. See JobComparatorType
  2. See SimpleCriterionKeyForJobType

SimpleScopeTermTypeDef#

# SimpleScopeTermTypeDef definition

class SimpleScopeTermTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    key: NotRequired[ScopeFilterKeyType],  # (2)
    values: NotRequired[Sequence[str]],
  1. See JobComparatorType
  2. See ScopeFilterKeyType

SuppressDataIdentifierTypeDef#

# SuppressDataIdentifierTypeDef definition

class SuppressDataIdentifierTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[DataIdentifierTypeType],  # (1)
  1. See DataIdentifierTypeType

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)
  1. See AutomatedDiscoveryStatusType
  2. See AutoEnableModeType

UpdateClassificationJobRequestRequestTypeDef#

# UpdateClassificationJobRequestRequestTypeDef definition

class UpdateClassificationJobRequestRequestTypeDef(TypedDict):
    jobId: str,
    jobStatus: JobStatusType,  # (1)
  1. See JobStatusType

UpdateMacieSessionRequestRequestTypeDef#

# UpdateMacieSessionRequestRequestTypeDef definition

class UpdateMacieSessionRequestRequestTypeDef(TypedDict):
    findingPublishingFrequency: NotRequired[FindingPublishingFrequencyType],  # (1)
    status: NotRequired[MacieStatusType],  # (2)
  1. See FindingPublishingFrequencyType
  2. See MacieStatusType

UpdateMemberSessionRequestRequestTypeDef#

# UpdateMemberSessionRequestRequestTypeDef definition

class UpdateMemberSessionRequestRequestTypeDef(TypedDict):
    id: str,
    status: MacieStatusType,  # (1)
  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],
  1. See RetrievalModeType

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]],
  1. See AccountDetailTypeDef

AccountLevelPermissionsTypeDef#

# AccountLevelPermissionsTypeDef definition

class AccountLevelPermissionsTypeDef(TypedDict):
    blockPublicAccess: NotRequired[BlockPublicAccessTypeDef],  # (1)
  1. See BlockPublicAccessTypeDef

AllowListCriteriaTypeDef#

# AllowListCriteriaTypeDef definition

class AllowListCriteriaTypeDef(TypedDict):
    regex: NotRequired[str],
    s3WordsList: NotRequired[S3WordsListTypeDef],  # (1)
  1. See S3WordsListTypeDef

FindingActionTypeDef#

# FindingActionTypeDef definition

class FindingActionTypeDef(TypedDict):
    actionType: NotRequired[FindingActionTypeType],  # (1)
    apiCallDetails: NotRequired[ApiCallDetailsTypeDef],  # (2)
  1. See FindingActionTypeType
  2. See ApiCallDetailsTypeDef

BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef#

# BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef definition

class BatchUpdateAutomatedDiscoveryAccountsRequestRequestTypeDef(TypedDict):
    accounts: NotRequired[Sequence[AutomatedDiscoveryAccountUpdateTypeDef]],  # (1)
  1. See AutomatedDiscoveryAccountUpdateTypeDef

BatchGetCustomDataIdentifiersResponseTypeDef#

# BatchGetCustomDataIdentifiersResponseTypeDef definition

class BatchGetCustomDataIdentifiersResponseTypeDef(TypedDict):
    customDataIdentifiers: list[BatchGetCustomDataIdentifierSummaryTypeDef],  # (1)
    notFoundIdentifierIds: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchGetCustomDataIdentifierSummaryTypeDef
  2. See ResponseMetadataTypeDef

BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef#

# BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef definition

class BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef(TypedDict):
    errors: list[AutomatedDiscoveryAccountUpdateErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AutomatedDiscoveryAccountUpdateErrorTypeDef
  2. See ResponseMetadataTypeDef

CreateAllowListResponseTypeDef#

# CreateAllowListResponseTypeDef definition

class CreateAllowListResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateClassificationJobResponseTypeDef#

# CreateClassificationJobResponseTypeDef definition

class CreateClassificationJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateCustomDataIdentifierResponseTypeDef#

# CreateCustomDataIdentifierResponseTypeDef definition

class CreateCustomDataIdentifierResponseTypeDef(TypedDict):
    customDataIdentifierId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFindingsFilterResponseTypeDef#

# CreateFindingsFilterResponseTypeDef definition

class CreateFindingsFilterResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMemberResponseTypeDef#

# CreateMemberResponseTypeDef definition

class CreateMemberResponseTypeDef(TypedDict):
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeOrganizationConfigurationResponseTypeDef#

# DescribeOrganizationConfigurationResponseTypeDef definition

class DescribeOrganizationConfigurationResponseTypeDef(TypedDict):
    autoEnable: bool,
    maxAccountLimitReached: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See AutoEnableModeType
  2. See AutomatedDiscoveryStatusType
  3. See ResponseMetadataTypeDef

GetInvitationsCountResponseTypeDef#

# GetInvitationsCountResponseTypeDef definition

class GetInvitationsCountResponseTypeDef(TypedDict):
    invitationsCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMacieSessionResponseTypeDef#

# GetMacieSessionResponseTypeDef definition

class GetMacieSessionResponseTypeDef(TypedDict):
    createdAt: datetime,
    findingPublishingFrequency: FindingPublishingFrequencyType,  # (1)
    serviceRole: str,
    status: MacieStatusType,  # (2)
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FindingPublishingFrequencyType
  2. See MacieStatusType
  3. See ResponseMetadataTypeDef

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)
  1. See RelationshipStatusType
  2. See ResponseMetadataTypeDef

GetSensitiveDataOccurrencesAvailabilityResponseTypeDef#

# GetSensitiveDataOccurrencesAvailabilityResponseTypeDef definition

class GetSensitiveDataOccurrencesAvailabilityResponseTypeDef(TypedDict):
    code: AvailabilityCodeType,  # (1)
    reasons: list[UnavailabilityReasonCodeType],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AvailabilityCodeType
  2. See UnavailabilityReasonCodeType
  3. See ResponseMetadataTypeDef

ListAllowListsResponseTypeDef#

# ListAllowListsResponseTypeDef definition

class ListAllowListsResponseTypeDef(TypedDict):
    allowLists: list[AllowListSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AllowListSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAutomatedDiscoveryAccountsResponseTypeDef#

# ListAutomatedDiscoveryAccountsResponseTypeDef definition

class ListAutomatedDiscoveryAccountsResponseTypeDef(TypedDict):
    items: list[AutomatedDiscoveryAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AutomatedDiscoveryAccountTypeDef
  2. See ResponseMetadataTypeDef

ListFindingsResponseTypeDef#

# ListFindingsResponseTypeDef definition

class ListFindingsResponseTypeDef(TypedDict):
    findingIds: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListOrganizationAdminAccountsResponseTypeDef#

# ListOrganizationAdminAccountsResponseTypeDef definition

class ListOrganizationAdminAccountsResponseTypeDef(TypedDict):
    adminAccounts: list[AdminAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AdminAccountTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

TestCustomDataIdentifierResponseTypeDef#

# TestCustomDataIdentifierResponseTypeDef definition

class TestCustomDataIdentifierResponseTypeDef(TypedDict):
    matchCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAllowListResponseTypeDef#

# UpdateAllowListResponseTypeDef definition

class UpdateAllowListResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFindingsFilterResponseTypeDef#

# UpdateFindingsFilterResponseTypeDef definition

class UpdateFindingsFilterResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BucketLevelPermissionsTypeDef#

# BucketLevelPermissionsTypeDef definition

class BucketLevelPermissionsTypeDef(TypedDict):
    accessControlList: NotRequired[AccessControlListTypeDef],  # (1)
    blockPublicAccess: NotRequired[BlockPublicAccessTypeDef],  # (2)
    bucketPolicy: NotRequired[BucketPolicyTypeDef],  # (3)
  1. See AccessControlListTypeDef
  2. See BlockPublicAccessTypeDef
  3. See BucketPolicyTypeDef

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)
  1. See AutomatedDiscoveryMonitoringStatusType
  2. See BucketMetadataErrorCodeType
  3. See JobDetailsTypeDef
  4. See ObjectCountByEncryptionTypeTypeDef
  5. See ObjectLevelStatisticsTypeDef
  6. See ObjectLevelStatisticsTypeDef

DescribeBucketsRequestRequestTypeDef#

# DescribeBucketsRequestRequestTypeDef definition

class DescribeBucketsRequestRequestTypeDef(TypedDict):
    criteria: NotRequired[Mapping[str, BucketCriteriaAdditionalPropertiesTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortCriteria: NotRequired[BucketSortCriteriaTypeDef],  # (2)
  1. See BucketCriteriaAdditionalPropertiesTypeDef
  2. See BucketSortCriteriaTypeDef

BucketStatisticsBySensitivityTypeDef#

# BucketStatisticsBySensitivityTypeDef definition

class BucketStatisticsBySensitivityTypeDef(TypedDict):
    classificationError: NotRequired[SensitivityAggregationsTypeDef],  # (1)
    notClassified: NotRequired[SensitivityAggregationsTypeDef],  # (1)
    notSensitive: NotRequired[SensitivityAggregationsTypeDef],  # (1)
    sensitive: NotRequired[SensitivityAggregationsTypeDef],  # (1)
  1. See SensitivityAggregationsTypeDef
  2. See SensitivityAggregationsTypeDef
  3. See SensitivityAggregationsTypeDef
  4. See SensitivityAggregationsTypeDef

ClassificationExportConfigurationTypeDef#

# ClassificationExportConfigurationTypeDef definition

class ClassificationExportConfigurationTypeDef(TypedDict):
    s3Destination: NotRequired[S3DestinationTypeDef],  # (1)
  1. See S3DestinationTypeDef

ListClassificationScopesResponseTypeDef#

# ListClassificationScopesResponseTypeDef definition

class ListClassificationScopesResponseTypeDef(TypedDict):
    classificationScopes: list[ClassificationScopeSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ClassificationScopeSummaryTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See SeverityLevelTypeDef

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)
  1. See SeverityLevelTypeDef
  2. See ResponseMetadataTypeDef

CreateInvitationsResponseTypeDef#

# CreateInvitationsResponseTypeDef definition

class CreateInvitationsResponseTypeDef(TypedDict):
    unprocessedAccounts: list[UnprocessedAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedAccountTypeDef
  2. See ResponseMetadataTypeDef

DeclineInvitationsResponseTypeDef#

# DeclineInvitationsResponseTypeDef definition

class DeclineInvitationsResponseTypeDef(TypedDict):
    unprocessedAccounts: list[UnprocessedAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedAccountTypeDef
  2. See ResponseMetadataTypeDef

DeleteInvitationsResponseTypeDef#

# DeleteInvitationsResponseTypeDef definition

class DeleteInvitationsResponseTypeDef(TypedDict):
    unprocessedAccounts: list[UnprocessedAccountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedAccountTypeDef
  2. See ResponseMetadataTypeDef

FindingCriteriaOutputTypeDef#

# FindingCriteriaOutputTypeDef definition

class FindingCriteriaOutputTypeDef(TypedDict):
    criterion: NotRequired[dict[str, CriterionAdditionalPropertiesOutputTypeDef]],  # (1)
  1. See CriterionAdditionalPropertiesOutputTypeDef

ListCustomDataIdentifiersResponseTypeDef#

# ListCustomDataIdentifiersResponseTypeDef definition

class ListCustomDataIdentifiersResponseTypeDef(TypedDict):
    items: list[CustomDataIdentifierSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CustomDataIdentifierSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeBucketsRequestPaginateTypeDef#

# DescribeBucketsRequestPaginateTypeDef definition

class DescribeBucketsRequestPaginateTypeDef(TypedDict):
    criteria: NotRequired[Mapping[str, BucketCriteriaAdditionalPropertiesTypeDef]],  # (1)
    sortCriteria: NotRequired[BucketSortCriteriaTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See BucketCriteriaAdditionalPropertiesTypeDef
  2. See BucketSortCriteriaTypeDef
  3. See PaginatorConfigTypeDef

ListAllowListsRequestPaginateTypeDef#

# ListAllowListsRequestPaginateTypeDef definition

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

ListAutomatedDiscoveryAccountsRequestPaginateTypeDef#

# ListAutomatedDiscoveryAccountsRequestPaginateTypeDef definition

class ListAutomatedDiscoveryAccountsRequestPaginateTypeDef(TypedDict):
    accountIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListClassificationScopesRequestPaginateTypeDef#

# ListClassificationScopesRequestPaginateTypeDef definition

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

ListCustomDataIdentifiersRequestPaginateTypeDef#

# ListCustomDataIdentifiersRequestPaginateTypeDef definition

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

ListFindingsFiltersRequestPaginateTypeDef#

# ListFindingsFiltersRequestPaginateTypeDef definition

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

ListInvitationsRequestPaginateTypeDef#

# ListInvitationsRequestPaginateTypeDef definition

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

ListManagedDataIdentifiersRequestPaginateTypeDef#

# ListManagedDataIdentifiersRequestPaginateTypeDef definition

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

ListMembersRequestPaginateTypeDef#

# ListMembersRequestPaginateTypeDef definition

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

ListOrganizationAdminAccountsRequestPaginateTypeDef#

# ListOrganizationAdminAccountsRequestPaginateTypeDef definition

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

ListResourceProfileArtifactsRequestPaginateTypeDef#

# ListResourceProfileArtifactsRequestPaginateTypeDef definition

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

ListResourceProfileDetectionsRequestPaginateTypeDef#

# ListResourceProfileDetectionsRequestPaginateTypeDef definition

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

ListSensitivityInspectionTemplatesRequestPaginateTypeDef#

# ListSensitivityInspectionTemplatesRequestPaginateTypeDef definition

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

GetSensitiveDataOccurrencesResponseTypeDef#

# GetSensitiveDataOccurrencesResponseTypeDef definition

class GetSensitiveDataOccurrencesResponseTypeDef(TypedDict):
    error: str,
    sensitiveDataOccurrences: dict[str, list[DetectedDataDetailsTypeDef]],  # (1)
    status: RevealRequestStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DetectedDataDetailsTypeDef
  2. See RevealRequestStatusType
  3. See ResponseMetadataTypeDef

ListResourceProfileDetectionsResponseTypeDef#

# ListResourceProfileDetectionsResponseTypeDef definition

class ListResourceProfileDetectionsResponseTypeDef(TypedDict):
    detections: list[DetectionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DetectionTypeDef
  2. See ResponseMetadataTypeDef

ListFindingsFiltersResponseTypeDef#

# ListFindingsFiltersResponseTypeDef definition

class ListFindingsFiltersResponseTypeDef(TypedDict):
    findingsFilterListItems: list[FindingsFilterListItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FindingsFilterListItemTypeDef
  2. See ResponseMetadataTypeDef

GetAdministratorAccountResponseTypeDef#

# GetAdministratorAccountResponseTypeDef definition

class GetAdministratorAccountResponseTypeDef(TypedDict):
    administrator: InvitationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InvitationTypeDef
  2. See ResponseMetadataTypeDef

GetMasterAccountResponseTypeDef#

# GetMasterAccountResponseTypeDef definition

class GetMasterAccountResponseTypeDef(TypedDict):
    master: InvitationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InvitationTypeDef
  2. See ResponseMetadataTypeDef

ListInvitationsResponseTypeDef#

# ListInvitationsResponseTypeDef definition

class ListInvitationsResponseTypeDef(TypedDict):
    invitations: list[InvitationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See InvitationTypeDef
  2. See ResponseMetadataTypeDef

GetFindingStatisticsResponseTypeDef#

# GetFindingStatisticsResponseTypeDef definition

class GetFindingStatisticsResponseTypeDef(TypedDict):
    countsByGroup: list[GroupCountTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupCountTypeDef
  2. See ResponseMetadataTypeDef

GetFindingsPublicationConfigurationResponseTypeDef#

# GetFindingsPublicationConfigurationResponseTypeDef definition

class GetFindingsPublicationConfigurationResponseTypeDef(TypedDict):
    securityHubConfiguration: SecurityHubConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SecurityHubConfigurationTypeDef
  2. See ResponseMetadataTypeDef

PutFindingsPublicationConfigurationRequestRequestTypeDef#

# PutFindingsPublicationConfigurationRequestRequestTypeDef definition

class PutFindingsPublicationConfigurationRequestRequestTypeDef(TypedDict):
    clientToken: NotRequired[str],
    securityHubConfiguration: NotRequired[SecurityHubConfigurationTypeDef],  # (1)
  1. See SecurityHubConfigurationTypeDef

GetFindingsRequestRequestTypeDef#

# GetFindingsRequestRequestTypeDef definition

class GetFindingsRequestRequestTypeDef(TypedDict):
    findingIds: Sequence[str],
    sortCriteria: NotRequired[SortCriteriaTypeDef],  # (1)
  1. See SortCriteriaTypeDef

GetResourceProfileResponseTypeDef#

# GetResourceProfileResponseTypeDef definition

class GetResourceProfileResponseTypeDef(TypedDict):
    profileUpdatedAt: datetime,
    sensitivityScore: int,
    sensitivityScoreOverridden: bool,
    statistics: ResourceStatisticsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceStatisticsTypeDef
  2. See ResponseMetadataTypeDef

GetRevealConfigurationResponseTypeDef#

# GetRevealConfigurationResponseTypeDef definition

class GetRevealConfigurationResponseTypeDef(TypedDict):
    configuration: RevealConfigurationTypeDef,  # (1)
    retrievalConfiguration: RetrievalConfigurationTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RevealConfigurationTypeDef
  2. See RetrievalConfigurationTypeDef
  3. See ResponseMetadataTypeDef

UpdateRevealConfigurationResponseTypeDef#

# UpdateRevealConfigurationResponseTypeDef definition

class UpdateRevealConfigurationResponseTypeDef(TypedDict):
    configuration: RevealConfigurationTypeDef,  # (1)
    retrievalConfiguration: RetrievalConfigurationTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RevealConfigurationTypeDef
  2. See RetrievalConfigurationTypeDef
  3. See ResponseMetadataTypeDef

GetSensitiveDataOccurrencesRequestWaitTypeDef#

# GetSensitiveDataOccurrencesRequestWaitTypeDef definition

class GetSensitiveDataOccurrencesRequestWaitTypeDef(TypedDict):
    findingId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetSensitivityInspectionTemplateResponseTypeDef#

# GetSensitivityInspectionTemplateResponseTypeDef definition

class GetSensitivityInspectionTemplateResponseTypeDef(TypedDict):
    description: str,
    excludes: SensitivityInspectionTemplateExcludesOutputTypeDef,  # (1)
    includes: SensitivityInspectionTemplateIncludesOutputTypeDef,  # (2)
    name: str,
    sensitivityInspectionTemplateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SensitivityInspectionTemplateExcludesOutputTypeDef
  2. See SensitivityInspectionTemplateIncludesOutputTypeDef
  3. See ResponseMetadataTypeDef

GetUsageStatisticsRequestPaginateTypeDef#

# GetUsageStatisticsRequestPaginateTypeDef definition

class GetUsageStatisticsRequestPaginateTypeDef(TypedDict):
    filterBy: NotRequired[Sequence[UsageStatisticsFilterTypeDef]],  # (1)
    sortBy: NotRequired[UsageStatisticsSortByTypeDef],  # (2)
    timeRange: NotRequired[TimeRangeType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See UsageStatisticsFilterTypeDef
  2. See UsageStatisticsSortByTypeDef
  3. See TimeRangeType
  4. 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)
  1. See UsageStatisticsFilterTypeDef
  2. See UsageStatisticsSortByTypeDef
  3. See TimeRangeType

GetUsageTotalsResponseTypeDef#

# GetUsageTotalsResponseTypeDef definition

class GetUsageTotalsResponseTypeDef(TypedDict):
    timeRange: TimeRangeType,  # (1)
    usageTotals: list[UsageTotalTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TimeRangeType
  2. See UsageTotalTypeDef
  3. 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)
  1. See IpCityTypeDef
  2. See IpCountryTypeDef
  3. See IpGeoLocationTypeDef
  4. See IpOwnerTypeDef

JobScheduleFrequencyOutputTypeDef#

# JobScheduleFrequencyOutputTypeDef definition

class JobScheduleFrequencyOutputTypeDef(TypedDict):
    dailySchedule: NotRequired[dict[str, Any]],
    monthlySchedule: NotRequired[MonthlyScheduleTypeDef],  # (1)
    weeklySchedule: NotRequired[WeeklyScheduleTypeDef],  # (2)
  1. See MonthlyScheduleTypeDef
  2. See WeeklyScheduleTypeDef

JobScheduleFrequencyTypeDef#

# JobScheduleFrequencyTypeDef definition

class JobScheduleFrequencyTypeDef(TypedDict):
    dailySchedule: NotRequired[Mapping[str, Any]],
    monthlySchedule: NotRequired[MonthlyScheduleTypeDef],  # (1)
    weeklySchedule: NotRequired[WeeklyScheduleTypeDef],  # (2)
  1. See MonthlyScheduleTypeDef
  2. See WeeklyScheduleTypeDef

ListJobsFilterCriteriaTypeDef#

# ListJobsFilterCriteriaTypeDef definition

class ListJobsFilterCriteriaTypeDef(TypedDict):
    excludes: NotRequired[Sequence[ListJobsFilterTermTypeDef]],  # (1)
    includes: NotRequired[Sequence[ListJobsFilterTermTypeDef]],  # (1)
  1. See ListJobsFilterTermTypeDef
  2. See ListJobsFilterTermTypeDef

ListManagedDataIdentifiersResponseTypeDef#

# ListManagedDataIdentifiersResponseTypeDef definition

class ListManagedDataIdentifiersResponseTypeDef(TypedDict):
    items: list[ManagedDataIdentifierSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ManagedDataIdentifierSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMembersResponseTypeDef#

# ListMembersResponseTypeDef definition

class ListMembersResponseTypeDef(TypedDict):
    members: list[MemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MemberTypeDef
  2. See ResponseMetadataTypeDef

ListResourceProfileArtifactsResponseTypeDef#

# ListResourceProfileArtifactsResponseTypeDef definition

class ListResourceProfileArtifactsResponseTypeDef(TypedDict):
    artifacts: list[ResourceProfileArtifactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ResourceProfileArtifactTypeDef
  2. See ResponseMetadataTypeDef

ListSensitivityInspectionTemplatesResponseTypeDef#

# ListSensitivityInspectionTemplatesResponseTypeDef definition

class ListSensitivityInspectionTemplatesResponseTypeDef(TypedDict):
    sensitivityInspectionTemplates: list[SensitivityInspectionTemplatesEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SensitivityInspectionTemplatesEntryTypeDef
  2. See ResponseMetadataTypeDef

PageTypeDef#

# PageTypeDef definition

class PageTypeDef(TypedDict):
    lineRange: NotRequired[RangeTypeDef],  # (1)
    offsetRange: NotRequired[RangeTypeDef],  # (1)
    pageNumber: NotRequired[int],
  1. See RangeTypeDef
  2. 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],
  1. See ServerSideEncryptionTypeDef
  2. See StorageClassType
  3. See KeyValuePairTypeDef

S3ClassificationScopeTypeDef#

# S3ClassificationScopeTypeDef definition

class S3ClassificationScopeTypeDef(TypedDict):
    excludes: S3ClassificationScopeExclusionTypeDef,  # (1)
  1. See S3ClassificationScopeExclusionTypeDef

S3ClassificationScopeUpdateTypeDef#

# S3ClassificationScopeUpdateTypeDef definition

class S3ClassificationScopeUpdateTypeDef(TypedDict):
    excludes: S3ClassificationScopeExclusionUpdateTypeDef,  # (1)
  1. See S3ClassificationScopeExclusionUpdateTypeDef

SearchResourcesTagCriterionTypeDef#

# SearchResourcesTagCriterionTypeDef definition

class SearchResourcesTagCriterionTypeDef(TypedDict):
    comparator: NotRequired[SearchResourcesComparatorType],  # (1)
    tagValues: NotRequired[Sequence[SearchResourcesTagCriterionPairTypeDef]],  # (2)
  1. See SearchResourcesComparatorType
  2. See SearchResourcesTagCriterionPairTypeDef

UpdateSensitivityInspectionTemplateRequestRequestTypeDef#

# UpdateSensitivityInspectionTemplateRequestRequestTypeDef definition

class UpdateSensitivityInspectionTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    description: NotRequired[str],
    excludes: NotRequired[SensitivityInspectionTemplateExcludesTypeDef],  # (1)
    includes: NotRequired[SensitivityInspectionTemplateIncludesTypeDef],  # (2)
  1. See SensitivityInspectionTemplateExcludesTypeDef
  2. See SensitivityInspectionTemplateIncludesTypeDef

UsageByAccountTypeDef#

# UsageByAccountTypeDef definition

class UsageByAccountTypeDef(TypedDict):
    currency: NotRequired[CurrencyType],  # (1)
    estimatedCost: NotRequired[str],
    serviceLimit: NotRequired[ServiceLimitTypeDef],  # (2)
    type: NotRequired[UsageTypeType],  # (3)
  1. See CurrencyType
  2. See ServiceLimitTypeDef
  3. See UsageTypeType

SessionContextTypeDef#

# SessionContextTypeDef definition

class SessionContextTypeDef(TypedDict):
    attributes: NotRequired[SessionContextAttributesTypeDef],  # (1)
    sessionIssuer: NotRequired[SessionIssuerTypeDef],  # (2)
  1. See SessionContextAttributesTypeDef
  2. See SessionIssuerTypeDef

UpdateResourceProfileDetectionsRequestRequestTypeDef#

# UpdateResourceProfileDetectionsRequestRequestTypeDef definition

class UpdateResourceProfileDetectionsRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    suppressDataIdentifiers: NotRequired[Sequence[SuppressDataIdentifierTypeDef]],  # (1)
  1. See SuppressDataIdentifierTypeDef

TagCriterionForJobOutputTypeDef#

# TagCriterionForJobOutputTypeDef definition

class TagCriterionForJobOutputTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    tagValues: NotRequired[list[TagCriterionPairForJobTypeDef]],  # (2)
  1. See JobComparatorType
  2. See TagCriterionPairForJobTypeDef

TagCriterionForJobTypeDef#

# TagCriterionForJobTypeDef definition

class TagCriterionForJobTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    tagValues: NotRequired[Sequence[TagCriterionPairForJobTypeDef]],  # (2)
  1. See JobComparatorType
  2. See TagCriterionPairForJobTypeDef

TagScopeTermOutputTypeDef#

# TagScopeTermOutputTypeDef definition

class TagScopeTermOutputTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    key: NotRequired[str],
    tagValues: NotRequired[list[TagValuePairTypeDef]],  # (2)
    target: NotRequired[TagTargetType],  # (3)
  1. See JobComparatorType
  2. See TagValuePairTypeDef
  3. See TagTargetType

TagScopeTermTypeDef#

# TagScopeTermTypeDef definition

class TagScopeTermTypeDef(TypedDict):
    comparator: NotRequired[JobComparatorType],  # (1)
    key: NotRequired[str],
    tagValues: NotRequired[Sequence[TagValuePairTypeDef]],  # (2)
    target: NotRequired[TagTargetType],  # (3)
  1. See JobComparatorType
  2. See TagValuePairTypeDef
  3. See TagTargetType

UpdateRevealConfigurationRequestRequestTypeDef#

# UpdateRevealConfigurationRequestRequestTypeDef definition

class UpdateRevealConfigurationRequestRequestTypeDef(TypedDict):
    configuration: RevealConfigurationTypeDef,  # (1)
    retrievalConfiguration: NotRequired[UpdateRetrievalConfigurationTypeDef],  # (2)
  1. See RevealConfigurationTypeDef
  2. See UpdateRetrievalConfigurationTypeDef

CreateAllowListRequestRequestTypeDef#

# CreateAllowListRequestRequestTypeDef definition

class CreateAllowListRequestRequestTypeDef(TypedDict):
    clientToken: str,
    criteria: AllowListCriteriaTypeDef,  # (1)
    name: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AllowListCriteriaTypeDef

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)
  1. See AllowListCriteriaTypeDef
  2. See AllowListStatusTypeDef
  3. See ResponseMetadataTypeDef

UpdateAllowListRequestRequestTypeDef#

# UpdateAllowListRequestRequestTypeDef definition

class UpdateAllowListRequestRequestTypeDef(TypedDict):
    criteria: AllowListCriteriaTypeDef,  # (1)
    id: str,
    name: str,
    description: NotRequired[str],
  1. See AllowListCriteriaTypeDef

BucketPermissionConfigurationTypeDef#

# BucketPermissionConfigurationTypeDef definition

class BucketPermissionConfigurationTypeDef(TypedDict):
    accountLevelPermissions: NotRequired[AccountLevelPermissionsTypeDef],  # (1)
    bucketLevelPermissions: NotRequired[BucketLevelPermissionsTypeDef],  # (2)
  1. See AccountLevelPermissionsTypeDef
  2. See BucketLevelPermissionsTypeDef

MatchingResourceTypeDef#

# MatchingResourceTypeDef definition

class MatchingResourceTypeDef(TypedDict):
    matchingBucket: NotRequired[MatchingBucketTypeDef],  # (1)
  1. See MatchingBucketTypeDef

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)
  1. See BucketCountByEffectivePermissionTypeDef
  2. See BucketCountByEncryptionTypeTypeDef
  3. See BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef
  4. See BucketCountBySharedAccessTypeTypeDef
  5. See BucketStatisticsBySensitivityTypeDef
  6. See ObjectLevelStatisticsTypeDef
  7. See ObjectLevelStatisticsTypeDef
  8. See ResponseMetadataTypeDef

GetClassificationExportConfigurationResponseTypeDef#

# GetClassificationExportConfigurationResponseTypeDef definition

class GetClassificationExportConfigurationResponseTypeDef(TypedDict):
    configuration: ClassificationExportConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClassificationExportConfigurationTypeDef
  2. See ResponseMetadataTypeDef

PutClassificationExportConfigurationRequestRequestTypeDef#

# PutClassificationExportConfigurationRequestRequestTypeDef definition

class PutClassificationExportConfigurationRequestRequestTypeDef(TypedDict):
    configuration: ClassificationExportConfigurationTypeDef,  # (1)
  1. See ClassificationExportConfigurationTypeDef

PutClassificationExportConfigurationResponseTypeDef#

# PutClassificationExportConfigurationResponseTypeDef definition

class PutClassificationExportConfigurationResponseTypeDef(TypedDict):
    configuration: ClassificationExportConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClassificationExportConfigurationTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See FindingsFilterActionType
  2. See FindingCriteriaOutputTypeDef
  3. See ResponseMetadataTypeDef

FindingCriteriaTypeDef#

# FindingCriteriaTypeDef definition

class FindingCriteriaTypeDef(TypedDict):
    criterion: NotRequired[Mapping[str, CriterionAdditionalPropertiesUnionTypeDef]],  # (1)
  1. See CriterionAdditionalPropertiesTypeDef CriterionAdditionalPropertiesOutputTypeDef

ListClassificationJobsRequestPaginateTypeDef#

# ListClassificationJobsRequestPaginateTypeDef definition

class ListClassificationJobsRequestPaginateTypeDef(TypedDict):
    filterCriteria: NotRequired[ListJobsFilterCriteriaTypeDef],  # (1)
    sortCriteria: NotRequired[ListJobsSortCriteriaTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See ListJobsFilterCriteriaTypeDef
  2. See ListJobsSortCriteriaTypeDef
  3. See PaginatorConfigTypeDef

ListClassificationJobsRequestRequestTypeDef#

# ListClassificationJobsRequestRequestTypeDef definition

class ListClassificationJobsRequestRequestTypeDef(TypedDict):
    filterCriteria: NotRequired[ListJobsFilterCriteriaTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortCriteria: NotRequired[ListJobsSortCriteriaTypeDef],  # (2)
  1. See ListJobsFilterCriteriaTypeDef
  2. See ListJobsSortCriteriaTypeDef

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)
  1. See CellTypeDef
  2. See RangeTypeDef
  3. See RangeTypeDef
  4. See PageTypeDef
  5. See RecordTypeDef

GetClassificationScopeResponseTypeDef#

# GetClassificationScopeResponseTypeDef definition

class GetClassificationScopeResponseTypeDef(TypedDict):
    id: str,
    name: str,
    s3: S3ClassificationScopeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See S3ClassificationScopeTypeDef
  2. See ResponseMetadataTypeDef

UpdateClassificationScopeRequestRequestTypeDef#

# UpdateClassificationScopeRequestRequestTypeDef definition

class UpdateClassificationScopeRequestRequestTypeDef(TypedDict):
    id: str,
    s3: NotRequired[S3ClassificationScopeUpdateTypeDef],  # (1)
  1. See S3ClassificationScopeUpdateTypeDef

SearchResourcesCriteriaTypeDef#

# SearchResourcesCriteriaTypeDef definition

class SearchResourcesCriteriaTypeDef(TypedDict):
    simpleCriterion: NotRequired[SearchResourcesSimpleCriterionTypeDef],  # (1)
    tagCriterion: NotRequired[SearchResourcesTagCriterionTypeDef],  # (2)
  1. See SearchResourcesSimpleCriterionTypeDef
  2. See SearchResourcesTagCriterionTypeDef

UsageRecordTypeDef#

# UsageRecordTypeDef definition

class UsageRecordTypeDef(TypedDict):
    accountId: NotRequired[str],
    automatedDiscoveryFreeTrialStartDate: NotRequired[datetime],
    freeTrialStartDate: NotRequired[datetime],
    usage: NotRequired[list[UsageByAccountTypeDef]],  # (1)
  1. See UsageByAccountTypeDef

AssumedRoleTypeDef#

# AssumedRoleTypeDef definition

class AssumedRoleTypeDef(TypedDict):
    accessKeyId: NotRequired[str],
    accountId: NotRequired[str],
    arn: NotRequired[str],
    principalId: NotRequired[str],
    sessionContext: NotRequired[SessionContextTypeDef],  # (1)
  1. See SessionContextTypeDef

FederatedUserTypeDef#

# FederatedUserTypeDef definition

class FederatedUserTypeDef(TypedDict):
    accessKeyId: NotRequired[str],
    accountId: NotRequired[str],
    arn: NotRequired[str],
    principalId: NotRequired[str],
    sessionContext: NotRequired[SessionContextTypeDef],  # (1)
  1. See SessionContextTypeDef

CriteriaForJobOutputTypeDef#

# CriteriaForJobOutputTypeDef definition

class CriteriaForJobOutputTypeDef(TypedDict):
    simpleCriterion: NotRequired[SimpleCriterionForJobOutputTypeDef],  # (1)
    tagCriterion: NotRequired[TagCriterionForJobOutputTypeDef],  # (2)
  1. See SimpleCriterionForJobOutputTypeDef
  2. See TagCriterionForJobOutputTypeDef

JobScopeTermOutputTypeDef#

# JobScopeTermOutputTypeDef definition

class JobScopeTermOutputTypeDef(TypedDict):
    simpleScopeTerm: NotRequired[SimpleScopeTermOutputTypeDef],  # (1)
    tagScopeTerm: NotRequired[TagScopeTermOutputTypeDef],  # (2)
  1. See SimpleScopeTermOutputTypeDef
  2. See TagScopeTermOutputTypeDef

BucketPublicAccessTypeDef#

# BucketPublicAccessTypeDef definition

class BucketPublicAccessTypeDef(TypedDict):
    effectivePermission: NotRequired[EffectivePermissionType],  # (1)
    permissionConfiguration: NotRequired[BucketPermissionConfigurationTypeDef],  # (2)
  1. See EffectivePermissionType
  2. See BucketPermissionConfigurationTypeDef

SearchResourcesResponseTypeDef#

# SearchResourcesResponseTypeDef definition

class SearchResourcesResponseTypeDef(TypedDict):
    matchingResources: list[MatchingResourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MatchingResourceTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See FindingsFilterActionType
  2. See FindingCriteriaTypeDef

GetFindingStatisticsRequestRequestTypeDef#

# GetFindingStatisticsRequestRequestTypeDef definition

class GetFindingStatisticsRequestRequestTypeDef(TypedDict):
    groupBy: GroupByType,  # (1)
    findingCriteria: NotRequired[FindingCriteriaTypeDef],  # (2)
    size: NotRequired[int],
    sortCriteria: NotRequired[FindingStatisticsSortCriteriaTypeDef],  # (3)
  1. See GroupByType
  2. See FindingCriteriaTypeDef
  3. See FindingStatisticsSortCriteriaTypeDef

ListFindingsRequestPaginateTypeDef#

# ListFindingsRequestPaginateTypeDef definition

class ListFindingsRequestPaginateTypeDef(TypedDict):
    findingCriteria: NotRequired[FindingCriteriaTypeDef],  # (1)
    sortCriteria: NotRequired[SortCriteriaTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See FindingCriteriaTypeDef
  2. See SortCriteriaTypeDef
  3. See PaginatorConfigTypeDef

ListFindingsRequestRequestTypeDef#

# ListFindingsRequestRequestTypeDef definition

class ListFindingsRequestRequestTypeDef(TypedDict):
    findingCriteria: NotRequired[FindingCriteriaTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortCriteria: NotRequired[SortCriteriaTypeDef],  # (2)
  1. See FindingCriteriaTypeDef
  2. See SortCriteriaTypeDef

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],
  1. See FindingsFilterActionType
  2. See FindingCriteriaTypeDef

CustomDetectionTypeDef#

# CustomDetectionTypeDef definition

class CustomDetectionTypeDef(TypedDict):
    arn: NotRequired[str],
    count: NotRequired[int],
    name: NotRequired[str],
    occurrences: NotRequired[OccurrencesTypeDef],  # (1)
  1. See OccurrencesTypeDef

DefaultDetectionTypeDef#

# DefaultDetectionTypeDef definition

class DefaultDetectionTypeDef(TypedDict):
    count: NotRequired[int],
    occurrences: NotRequired[OccurrencesTypeDef],  # (1)
    type: NotRequired[str],
  1. See OccurrencesTypeDef

SearchResourcesCriteriaBlockTypeDef#

# SearchResourcesCriteriaBlockTypeDef definition

class SearchResourcesCriteriaBlockTypeDef(TypedDict):
    and: NotRequired[Sequence[SearchResourcesCriteriaTypeDef]],  # (1)
  1. See SearchResourcesCriteriaTypeDef

GetUsageStatisticsResponseTypeDef#

# GetUsageStatisticsResponseTypeDef definition

class GetUsageStatisticsResponseTypeDef(TypedDict):
    records: list[UsageRecordTypeDef],  # (1)
    timeRange: TimeRangeType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See UsageRecordTypeDef
  2. See TimeRangeType
  3. 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)
  1. See AssumedRoleTypeDef
  2. See AwsAccountTypeDef
  3. See AwsServiceTypeDef
  4. See FederatedUserTypeDef
  5. See IamUserTypeDef
  6. See UserIdentityRootTypeDef
  7. See UserIdentityTypeType

CriteriaBlockForJobOutputTypeDef#

# CriteriaBlockForJobOutputTypeDef definition

class CriteriaBlockForJobOutputTypeDef(TypedDict):
    and: NotRequired[list[CriteriaForJobOutputTypeDef]],  # (1)
  1. See CriteriaForJobOutputTypeDef

CriteriaForJobTypeDef#

# CriteriaForJobTypeDef definition

class CriteriaForJobTypeDef(TypedDict):
    simpleCriterion: NotRequired[SimpleCriterionForJobUnionTypeDef],  # (1)
    tagCriterion: NotRequired[TagCriterionForJobUnionTypeDef],  # (2)
  1. See SimpleCriterionForJobTypeDef SimpleCriterionForJobOutputTypeDef
  2. See TagCriterionForJobTypeDef TagCriterionForJobOutputTypeDef

JobScopingBlockOutputTypeDef#

# JobScopingBlockOutputTypeDef definition

class JobScopingBlockOutputTypeDef(TypedDict):
    and: NotRequired[list[JobScopeTermOutputTypeDef]],  # (1)
  1. See JobScopeTermOutputTypeDef

JobScopeTermTypeDef#

# JobScopeTermTypeDef definition

class JobScopeTermTypeDef(TypedDict):
    simpleScopeTerm: NotRequired[SimpleScopeTermUnionTypeDef],  # (1)
    tagScopeTerm: NotRequired[TagScopeTermUnionTypeDef],  # (2)
  1. See SimpleScopeTermTypeDef SimpleScopeTermOutputTypeDef
  2. 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],
  1. See AllowsUnencryptedObjectUploadsType
  2. See AutomatedDiscoveryMonitoringStatusType
  3. See BucketMetadataErrorCodeType
  4. See JobDetailsTypeDef
  5. See ObjectCountByEncryptionTypeTypeDef
  6. See BucketPublicAccessTypeDef
  7. See ReplicationDetailsTypeDef
  8. See BucketServerSideEncryptionTypeDef
  9. See SharedAccessType
  10. See KeyValuePairTypeDef
  11. See ObjectLevelStatisticsTypeDef
  12. 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)
  1. See AllowsUnencryptedObjectUploadsType
  2. See ServerSideEncryptionTypeDef
  3. See S3BucketOwnerTypeDef
  4. See BucketPublicAccessTypeDef
  5. See KeyValuePairTypeDef

CustomDataIdentifiersTypeDef#

# CustomDataIdentifiersTypeDef definition

class CustomDataIdentifiersTypeDef(TypedDict):
    detections: NotRequired[list[CustomDetectionTypeDef]],  # (1)
    totalCount: NotRequired[int],
  1. See CustomDetectionTypeDef

SensitiveDataItemTypeDef#

# SensitiveDataItemTypeDef definition

class SensitiveDataItemTypeDef(TypedDict):
    category: NotRequired[SensitiveDataItemCategoryType],  # (1)
    detections: NotRequired[list[DefaultDetectionTypeDef]],  # (2)
    totalCount: NotRequired[int],
  1. See SensitiveDataItemCategoryType
  2. See DefaultDetectionTypeDef

SearchResourcesBucketCriteriaTypeDef#

# SearchResourcesBucketCriteriaTypeDef definition

class SearchResourcesBucketCriteriaTypeDef(TypedDict):
    excludes: NotRequired[SearchResourcesCriteriaBlockTypeDef],  # (1)
    includes: NotRequired[SearchResourcesCriteriaBlockTypeDef],  # (1)
  1. See SearchResourcesCriteriaBlockTypeDef
  2. See SearchResourcesCriteriaBlockTypeDef

FindingActorTypeDef#

# FindingActorTypeDef definition

class FindingActorTypeDef(TypedDict):
    domainDetails: NotRequired[DomainDetailsTypeDef],  # (1)
    ipAddressDetails: NotRequired[IpAddressDetailsTypeDef],  # (2)
    userIdentity: NotRequired[UserIdentityTypeDef],  # (3)
  1. See DomainDetailsTypeDef
  2. See IpAddressDetailsTypeDef
  3. See UserIdentityTypeDef

S3BucketCriteriaForJobOutputTypeDef#

# S3BucketCriteriaForJobOutputTypeDef definition

class S3BucketCriteriaForJobOutputTypeDef(TypedDict):
    excludes: NotRequired[CriteriaBlockForJobOutputTypeDef],  # (1)
    includes: NotRequired[CriteriaBlockForJobOutputTypeDef],  # (1)
  1. See CriteriaBlockForJobOutputTypeDef
  2. See CriteriaBlockForJobOutputTypeDef

ScopingOutputTypeDef#

# ScopingOutputTypeDef definition

class ScopingOutputTypeDef(TypedDict):
    excludes: NotRequired[JobScopingBlockOutputTypeDef],  # (1)
    includes: NotRequired[JobScopingBlockOutputTypeDef],  # (1)
  1. See JobScopingBlockOutputTypeDef
  2. See JobScopingBlockOutputTypeDef

DescribeBucketsResponseTypeDef#

# DescribeBucketsResponseTypeDef definition

class DescribeBucketsResponseTypeDef(TypedDict):
    buckets: list[BucketMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BucketMetadataTypeDef
  2. See ResponseMetadataTypeDef

ResourcesAffectedTypeDef#

# ResourcesAffectedTypeDef definition

class ResourcesAffectedTypeDef(TypedDict):
    s3Bucket: NotRequired[S3BucketTypeDef],  # (1)
    s3Object: NotRequired[S3ObjectTypeDef],  # (2)
  1. See S3BucketTypeDef
  2. 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)
  1. See CustomDataIdentifiersTypeDef
  2. See SensitiveDataItemTypeDef
  3. See ClassificationResultStatusTypeDef

SearchResourcesRequestPaginateTypeDef#

# SearchResourcesRequestPaginateTypeDef definition

class SearchResourcesRequestPaginateTypeDef(TypedDict):
    bucketCriteria: NotRequired[SearchResourcesBucketCriteriaTypeDef],  # (1)
    sortCriteria: NotRequired[SearchResourcesSortCriteriaTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SearchResourcesBucketCriteriaTypeDef
  2. See SearchResourcesSortCriteriaTypeDef
  3. See PaginatorConfigTypeDef

SearchResourcesRequestRequestTypeDef#

# SearchResourcesRequestRequestTypeDef definition

class SearchResourcesRequestRequestTypeDef(TypedDict):
    bucketCriteria: NotRequired[SearchResourcesBucketCriteriaTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortCriteria: NotRequired[SearchResourcesSortCriteriaTypeDef],  # (2)
  1. See SearchResourcesBucketCriteriaTypeDef
  2. See SearchResourcesSortCriteriaTypeDef

PolicyDetailsTypeDef#

# PolicyDetailsTypeDef definition

class PolicyDetailsTypeDef(TypedDict):
    action: NotRequired[FindingActionTypeDef],  # (1)
    actor: NotRequired[FindingActorTypeDef],  # (2)
  1. See FindingActionTypeDef
  2. See FindingActorTypeDef

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)
  1. See S3BucketCriteriaForJobOutputTypeDef
  2. See S3BucketDefinitionForJobOutputTypeDef
  3. See JobStatusType
  4. See JobTypeType
  5. See LastRunErrorStatusTypeDef
  6. See UserPausedDetailsTypeDef

CriteriaBlockForJobTypeDef#

# CriteriaBlockForJobTypeDef definition

class CriteriaBlockForJobTypeDef(TypedDict):
    and: NotRequired[Sequence[CriteriaForJobUnionTypeDef]],  # (1)
  1. See CriteriaForJobTypeDef CriteriaForJobOutputTypeDef

S3JobDefinitionOutputTypeDef#

# S3JobDefinitionOutputTypeDef definition

class S3JobDefinitionOutputTypeDef(TypedDict):
    bucketCriteria: NotRequired[S3BucketCriteriaForJobOutputTypeDef],  # (1)
    bucketDefinitions: NotRequired[list[S3BucketDefinitionForJobOutputTypeDef]],  # (2)
    scoping: NotRequired[ScopingOutputTypeDef],  # (3)
  1. See S3BucketCriteriaForJobOutputTypeDef
  2. See S3BucketDefinitionForJobOutputTypeDef
  3. See ScopingOutputTypeDef

JobScopingBlockTypeDef#

# JobScopingBlockTypeDef definition

class JobScopingBlockTypeDef(TypedDict):
    and: NotRequired[Sequence[JobScopeTermUnionTypeDef]],  # (1)
  1. See JobScopeTermTypeDef JobScopeTermOutputTypeDef

ClassificationDetailsTypeDef#

# ClassificationDetailsTypeDef definition

class ClassificationDetailsTypeDef(TypedDict):
    detailedResultsLocation: NotRequired[str],
    jobArn: NotRequired[str],
    jobId: NotRequired[str],
    originType: NotRequired[OriginTypeType],  # (1)
    result: NotRequired[ClassificationResultTypeDef],  # (2)
  1. See OriginTypeType
  2. See ClassificationResultTypeDef

ListClassificationJobsResponseTypeDef#

# ListClassificationJobsResponseTypeDef definition

class ListClassificationJobsResponseTypeDef(TypedDict):
    items: list[JobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See JobStatusType
  2. See JobTypeType
  3. See LastRunErrorStatusTypeDef
  4. See ManagedDataIdentifierSelectorType
  5. See S3JobDefinitionOutputTypeDef
  6. See JobScheduleFrequencyOutputTypeDef
  7. See StatisticsTypeDef
  8. See UserPausedDetailsTypeDef
  9. 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],
  1. See FindingCategoryType
  2. See ClassificationDetailsTypeDef
  3. See PolicyDetailsTypeDef
  4. See ResourcesAffectedTypeDef
  5. See SeverityTypeDef
  6. See FindingTypeType

S3BucketCriteriaForJobTypeDef#

# S3BucketCriteriaForJobTypeDef definition

class S3BucketCriteriaForJobTypeDef(TypedDict):
    excludes: NotRequired[CriteriaBlockForJobUnionTypeDef],  # (1)
    includes: NotRequired[CriteriaBlockForJobUnionTypeDef],  # (1)
  1. See CriteriaBlockForJobTypeDef CriteriaBlockForJobOutputTypeDef
  2. See CriteriaBlockForJobTypeDef CriteriaBlockForJobOutputTypeDef

ScopingTypeDef#

# ScopingTypeDef definition

class ScopingTypeDef(TypedDict):
    excludes: NotRequired[JobScopingBlockUnionTypeDef],  # (1)
    includes: NotRequired[JobScopingBlockUnionTypeDef],  # (1)
  1. See JobScopingBlockTypeDef JobScopingBlockOutputTypeDef
  2. See JobScopingBlockTypeDef JobScopingBlockOutputTypeDef

GetFindingsResponseTypeDef#

# GetFindingsResponseTypeDef definition

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

S3JobDefinitionTypeDef#

# S3JobDefinitionTypeDef definition

class S3JobDefinitionTypeDef(TypedDict):
    bucketCriteria: NotRequired[S3BucketCriteriaForJobUnionTypeDef],  # (1)
    bucketDefinitions: NotRequired[Sequence[S3BucketDefinitionForJobUnionTypeDef]],  # (2)
    scoping: NotRequired[ScopingUnionTypeDef],  # (3)
  1. See S3BucketCriteriaForJobTypeDef S3BucketCriteriaForJobOutputTypeDef
  2. See S3BucketDefinitionForJobTypeDef S3BucketDefinitionForJobOutputTypeDef
  3. 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]],
  1. See JobTypeType
  2. See S3JobDefinitionTypeDef
  3. See ManagedDataIdentifierSelectorType
  4. See JobScheduleFrequencyTypeDef