Macie2 module#
Index > Macie2
Auto-generated documentation for Macie2 type annotations stubs module types-boto3-macie2.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
Macie2
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Macie2
.
From PyPI with pip#
Install types-boto3
for Macie2
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[macie2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[macie2]'
# standalone installation
python -m pip install types-boto3-macie2
How to uninstall#
python -m pip uninstall -y types-boto3-macie2
Usage#
Code samples can be found in Examples.
Macie2Client#
Type annotations and code completion for boto3.client("macie2")
as Macie2Client
boto3 documentation
# Macie2Client usage example
from boto3.session import Session
from types_boto3_macie2.client import Macie2Client
def get_client() -> Macie2Client:
return Session().client("macie2")
Paginators#
Type annotations and code completion for paginators
from boto3.client("macie2").get_paginator("...")
.
# DescribeBucketsPaginator usage example
from boto3.session import Session
from types_boto3_macie2.paginator import DescribeBucketsPaginator
def get_describe_buckets_paginator() -> DescribeBucketsPaginator:
return Session().client("macie2").get_paginator("describe_buckets"))
- DescribeBucketsPaginator
- GetUsageStatisticsPaginator
- ListAllowListsPaginator
- ListAutomatedDiscoveryAccountsPaginator
- ListClassificationJobsPaginator
- ListClassificationScopesPaginator
- ListCustomDataIdentifiersPaginator
- ListFindingsFiltersPaginator
- ListFindingsPaginator
- ListInvitationsPaginator
- ListManagedDataIdentifiersPaginator
- ListMembersPaginator
- ListOrganizationAdminAccountsPaginator
- ListResourceProfileArtifactsPaginator
- ListResourceProfileDetectionsPaginator
- ListSensitivityInspectionTemplatesPaginator
- SearchResourcesPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("macie2").get_waiter("...")
.
# FindingRevealedWaiter usage example
from boto3.session import Session
from types_boto3_macie2.waiter import FindingRevealedWaiter
def get_finding_revealed_waiter() -> FindingRevealedWaiter:
return Session().client("macie2").get_waiter("finding_revealed")
Literals#
Type annotations for literals used in methods and schema.
# AdminStatusType usage example
from types_boto3_macie2.literals import AdminStatusType
def get_value() -> AdminStatusType:
return "DISABLING_IN_PROGRESS"
- AdminStatusType
- AllowListStatusCodeType
- AllowsUnencryptedObjectUploadsType
- AutoEnableModeType
- AutomatedDiscoveryAccountStatusType
- AutomatedDiscoveryAccountUpdateErrorCodeType
- AutomatedDiscoveryMonitoringStatusType
- AutomatedDiscoveryStatusType
- AvailabilityCodeType
- BucketMetadataErrorCodeType
- ClassificationScopeUpdateOperationType
- CurrencyType
- DataIdentifierSeverityType
- DataIdentifierTypeType
- DayOfWeekType
- DescribeBucketsPaginatorName
- EffectivePermissionType
- EncryptionTypeType
- ErrorCodeType
- FindingActionTypeType
- FindingCategoryType
- FindingPublishingFrequencyType
- FindingRevealedWaiterName
- FindingStatisticsSortAttributeNameType
- FindingTypeType
- FindingsFilterActionType
- GetUsageStatisticsPaginatorName
- GroupByType
- IsDefinedInJobType
- IsMonitoredByJobType
- JobComparatorType
- JobStatusType
- JobTypeType
- LastRunErrorStatusCodeType
- ListAllowListsPaginatorName
- ListAutomatedDiscoveryAccountsPaginatorName
- ListClassificationJobsPaginatorName
- ListClassificationScopesPaginatorName
- ListCustomDataIdentifiersPaginatorName
- ListFindingsFiltersPaginatorName
- ListFindingsPaginatorName
- ListInvitationsPaginatorName
- ListJobsFilterKeyType
- ListJobsSortAttributeNameType
- ListManagedDataIdentifiersPaginatorName
- ListMembersPaginatorName
- ListOrganizationAdminAccountsPaginatorName
- ListResourceProfileArtifactsPaginatorName
- ListResourceProfileDetectionsPaginatorName
- ListSensitivityInspectionTemplatesPaginatorName
- MacieStatusType
- ManagedDataIdentifierSelectorType
- OrderByType
- OriginTypeType
- RelationshipStatusType
- RetrievalModeType
- RevealRequestStatusType
- RevealStatusType
- ScopeFilterKeyType
- SearchResourcesComparatorType
- SearchResourcesPaginatorName
- SearchResourcesSimpleCriterionKeyType
- SearchResourcesSortAttributeNameType
- SensitiveDataItemCategoryType
- SeverityDescriptionType
- SharedAccessType
- SimpleCriterionKeyForJobType
- StorageClassType
- TagTargetType
- TimeRangeType
- TypeType
- UnavailabilityReasonCodeType
- UnitType
- UsageStatisticsFilterComparatorType
- UsageStatisticsFilterKeyType
- UsageStatisticsSortKeyType
- UsageTypeType
- UserIdentityTypeType
- Macie2ServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcceptInvitationRequestTypeDef
- AccessControlListTypeDef
- AccountDetailTypeDef
- BlockPublicAccessTypeDef
- AdminAccountTypeDef
- S3WordsListTypeDef
- AllowListStatusTypeDef
- AllowListSummaryTypeDef
- ApiCallDetailsTypeDef
- AutomatedDiscoveryAccountTypeDef
- AutomatedDiscoveryAccountUpdateErrorTypeDef
- AutomatedDiscoveryAccountUpdateTypeDef
- AwsAccountTypeDef
- AwsServiceTypeDef
- BatchGetCustomDataIdentifierSummaryTypeDef
- BatchGetCustomDataIdentifiersRequestTypeDef
- ResponseMetadataTypeDef
- BucketCountByEffectivePermissionTypeDef
- BucketCountByEncryptionTypeTypeDef
- BucketCountBySharedAccessTypeTypeDef
- BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef
- BucketCriteriaAdditionalPropertiesTypeDef
- BucketPolicyTypeDef
- BucketServerSideEncryptionTypeDef
- JobDetailsTypeDef
- KeyValuePairTypeDef
- ObjectCountByEncryptionTypeTypeDef
- ObjectLevelStatisticsTypeDef
- ReplicationDetailsTypeDef
- BucketSortCriteriaTypeDef
- SensitivityAggregationsTypeDef
- CellTypeDef
- S3DestinationTypeDef
- ClassificationResultStatusTypeDef
- ClassificationScopeSummaryTypeDef
- SeverityLevelTypeDef
- CreateInvitationsRequestTypeDef
- UnprocessedAccountTypeDef
- CreateSampleFindingsRequestTypeDef
- SimpleCriterionForJobOutputTypeDef
- SimpleCriterionForJobTypeDef
- CriterionAdditionalPropertiesOutputTypeDef
- CriterionAdditionalPropertiesTypeDef
- CustomDataIdentifierSummaryTypeDef
- DeclineInvitationsRequestTypeDef
- DeleteAllowListRequestTypeDef
- DeleteCustomDataIdentifierRequestTypeDef
- DeleteFindingsFilterRequestTypeDef
- DeleteInvitationsRequestTypeDef
- DeleteMemberRequestTypeDef
- PaginatorConfigTypeDef
- DescribeClassificationJobRequestTypeDef
- LastRunErrorStatusTypeDef
- StatisticsTypeDef
- UserPausedDetailsTypeDef
- DetectedDataDetailsTypeDef
- DetectionTypeDef
- DisableOrganizationAdminAccountRequestTypeDef
- DisassociateMemberRequestTypeDef
- DomainDetailsTypeDef
- EnableMacieRequestTypeDef
- EnableOrganizationAdminAccountRequestTypeDef
- FindingStatisticsSortCriteriaTypeDef
- SeverityTypeDef
- FindingsFilterListItemTypeDef
- InvitationTypeDef
- GetAllowListRequestTypeDef
- GetBucketStatisticsRequestTypeDef
- GetClassificationScopeRequestTypeDef
- GetCustomDataIdentifierRequestTypeDef
- GroupCountTypeDef
- GetFindingsFilterRequestTypeDef
- SecurityHubConfigurationTypeDef
- SortCriteriaTypeDef
- GetMemberRequestTypeDef
- GetResourceProfileRequestTypeDef
- ResourceStatisticsTypeDef
- RetrievalConfigurationTypeDef
- RevealConfigurationTypeDef
- GetSensitiveDataOccurrencesAvailabilityRequestTypeDef
- GetSensitiveDataOccurrencesRequestTypeDef
- WaiterConfigTypeDef
- GetSensitivityInspectionTemplateRequestTypeDef
- SensitivityInspectionTemplateExcludesOutputTypeDef
- SensitivityInspectionTemplateIncludesOutputTypeDef
- UsageStatisticsFilterTypeDef
- UsageStatisticsSortByTypeDef
- GetUsageTotalsRequestTypeDef
- UsageTotalTypeDef
- IamUserTypeDef
- IpCityTypeDef
- IpCountryTypeDef
- IpGeoLocationTypeDef
- IpOwnerTypeDef
- MonthlyScheduleTypeDef
- WeeklyScheduleTypeDef
- SimpleScopeTermOutputTypeDef
- SimpleScopeTermTypeDef
- S3BucketDefinitionForJobOutputTypeDef
- ListAllowListsRequestTypeDef
- ListAutomatedDiscoveryAccountsRequestTypeDef
- ListJobsSortCriteriaTypeDef
- ListClassificationScopesRequestTypeDef
- ListCustomDataIdentifiersRequestTypeDef
- ListFindingsFiltersRequestTypeDef
- ListInvitationsRequestTypeDef
- ListJobsFilterTermTypeDef
- ListManagedDataIdentifiersRequestTypeDef
- ManagedDataIdentifierSummaryTypeDef
- ListMembersRequestTypeDef
- MemberTypeDef
- ListOrganizationAdminAccountsRequestTypeDef
- ListResourceProfileArtifactsRequestTypeDef
- ResourceProfileArtifactTypeDef
- ListResourceProfileDetectionsRequestTypeDef
- ListSensitivityInspectionTemplatesRequestTypeDef
- SensitivityInspectionTemplatesEntryTypeDef
- ListTagsForResourceRequestTypeDef
- RangeTypeDef
- RecordTypeDef
- S3BucketDefinitionForJobTypeDef
- S3BucketOwnerTypeDef
- ServerSideEncryptionTypeDef
- S3ClassificationScopeExclusionTypeDef
- S3ClassificationScopeExclusionUpdateTypeDef
- SearchResourcesSimpleCriterionTypeDef
- SearchResourcesSortCriteriaTypeDef
- SearchResourcesTagCriterionPairTypeDef
- SensitivityInspectionTemplateExcludesTypeDef
- SensitivityInspectionTemplateIncludesTypeDef
- ServiceLimitTypeDef
- SessionContextAttributesTypeDef
- SessionIssuerTypeDef
- SuppressDataIdentifierTypeDef
- TagCriterionPairForJobTypeDef
- TagResourceRequestTypeDef
- TagValuePairTypeDef
- TestCustomDataIdentifierRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateAutomatedDiscoveryConfigurationRequestTypeDef
- UpdateClassificationJobRequestTypeDef
- UpdateMacieSessionRequestTypeDef
- UpdateMemberSessionRequestTypeDef
- UpdateOrganizationConfigurationRequestTypeDef
- UpdateResourceProfileRequestTypeDef
- UpdateRetrievalConfigurationTypeDef
- UserIdentityRootTypeDef
- CreateMemberRequestTypeDef
- AccountLevelPermissionsTypeDef
- AllowListCriteriaTypeDef
- FindingActionTypeDef
- BatchUpdateAutomatedDiscoveryAccountsRequestTypeDef
- BatchGetCustomDataIdentifiersResponseTypeDef
- BatchUpdateAutomatedDiscoveryAccountsResponseTypeDef
- CreateAllowListResponseTypeDef
- CreateClassificationJobResponseTypeDef
- CreateCustomDataIdentifierResponseTypeDef
- CreateFindingsFilterResponseTypeDef
- CreateMemberResponseTypeDef
- DescribeOrganizationConfigurationResponseTypeDef
- GetAutomatedDiscoveryConfigurationResponseTypeDef
- GetInvitationsCountResponseTypeDef
- GetMacieSessionResponseTypeDef
- GetMemberResponseTypeDef
- GetSensitiveDataOccurrencesAvailabilityResponseTypeDef
- ListAllowListsResponseTypeDef
- ListAutomatedDiscoveryAccountsResponseTypeDef
- ListFindingsResponseTypeDef
- ListOrganizationAdminAccountsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TestCustomDataIdentifierResponseTypeDef
- UpdateAllowListResponseTypeDef
- UpdateFindingsFilterResponseTypeDef
- BucketLevelPermissionsTypeDef
- MatchingBucketTypeDef
- DescribeBucketsRequestTypeDef
- BucketStatisticsBySensitivityTypeDef
- ClassificationExportConfigurationTypeDef
- ListClassificationScopesResponseTypeDef
- CreateCustomDataIdentifierRequestTypeDef
- GetCustomDataIdentifierResponseTypeDef
- CreateInvitationsResponseTypeDef
- DeclineInvitationsResponseTypeDef
- DeleteInvitationsResponseTypeDef
- FindingCriteriaOutputTypeDef
- FindingCriteriaTypeDef
- ListCustomDataIdentifiersResponseTypeDef
- DescribeBucketsRequestPaginateTypeDef
- ListAllowListsRequestPaginateTypeDef
- ListAutomatedDiscoveryAccountsRequestPaginateTypeDef
- ListClassificationScopesRequestPaginateTypeDef
- ListCustomDataIdentifiersRequestPaginateTypeDef
- ListFindingsFiltersRequestPaginateTypeDef
- ListInvitationsRequestPaginateTypeDef
- ListManagedDataIdentifiersRequestPaginateTypeDef
- ListMembersRequestPaginateTypeDef
- ListOrganizationAdminAccountsRequestPaginateTypeDef
- ListResourceProfileArtifactsRequestPaginateTypeDef
- ListResourceProfileDetectionsRequestPaginateTypeDef
- ListSensitivityInspectionTemplatesRequestPaginateTypeDef
- GetSensitiveDataOccurrencesResponseTypeDef
- ListResourceProfileDetectionsResponseTypeDef
- ListFindingsFiltersResponseTypeDef
- GetAdministratorAccountResponseTypeDef
- GetMasterAccountResponseTypeDef
- ListInvitationsResponseTypeDef
- GetFindingStatisticsResponseTypeDef
- GetFindingsPublicationConfigurationResponseTypeDef
- PutFindingsPublicationConfigurationRequestTypeDef
- GetFindingsRequestTypeDef
- GetResourceProfileResponseTypeDef
- GetRevealConfigurationResponseTypeDef
- UpdateRevealConfigurationResponseTypeDef
- GetSensitiveDataOccurrencesRequestWaitTypeDef
- GetSensitivityInspectionTemplateResponseTypeDef
- GetUsageStatisticsRequestPaginateTypeDef
- GetUsageStatisticsRequestTypeDef
- GetUsageTotalsResponseTypeDef
- IpAddressDetailsTypeDef
- JobScheduleFrequencyOutputTypeDef
- JobScheduleFrequencyTypeDef
- ListJobsFilterCriteriaTypeDef
- ListManagedDataIdentifiersResponseTypeDef
- ListMembersResponseTypeDef
- ListResourceProfileArtifactsResponseTypeDef
- ListSensitivityInspectionTemplatesResponseTypeDef
- PageTypeDef
- S3ObjectTypeDef
- S3ClassificationScopeTypeDef
- S3ClassificationScopeUpdateTypeDef
- SearchResourcesTagCriterionTypeDef
- SensitivityInspectionTemplateExcludesUnionTypeDef
- SensitivityInspectionTemplateIncludesUnionTypeDef
- UsageByAccountTypeDef
- SessionContextTypeDef
- UpdateResourceProfileDetectionsRequestTypeDef
- TagCriterionForJobOutputTypeDef
- TagCriterionForJobTypeDef
- TagScopeTermOutputTypeDef
- TagScopeTermTypeDef
- UpdateRevealConfigurationRequestTypeDef
- CreateAllowListRequestTypeDef
- GetAllowListResponseTypeDef
- UpdateAllowListRequestTypeDef
- BucketPermissionConfigurationTypeDef
- MatchingResourceTypeDef
- GetBucketStatisticsResponseTypeDef
- GetClassificationExportConfigurationResponseTypeDef
- PutClassificationExportConfigurationRequestTypeDef
- PutClassificationExportConfigurationResponseTypeDef
- GetFindingsFilterResponseTypeDef
- FindingCriteriaUnionTypeDef
- JobScheduleFrequencyUnionTypeDef
- ListClassificationJobsRequestPaginateTypeDef
- ListClassificationJobsRequestTypeDef
- OccurrencesTypeDef
- GetClassificationScopeResponseTypeDef
- UpdateClassificationScopeRequestTypeDef
- SearchResourcesCriteriaTypeDef
- UpdateSensitivityInspectionTemplateRequestTypeDef
- UsageRecordTypeDef
- AssumedRoleTypeDef
- FederatedUserTypeDef
- CriteriaForJobOutputTypeDef
- CriteriaForJobTypeDef
- JobScopeTermOutputTypeDef
- JobScopeTermTypeDef
- BucketPublicAccessTypeDef
- SearchResourcesResponseTypeDef
- CreateFindingsFilterRequestTypeDef
- GetFindingStatisticsRequestTypeDef
- ListFindingsRequestPaginateTypeDef
- ListFindingsRequestTypeDef
- UpdateFindingsFilterRequestTypeDef
- CustomDetectionTypeDef
- DefaultDetectionTypeDef
- SearchResourcesCriteriaBlockTypeDef
- GetUsageStatisticsResponseTypeDef
- UserIdentityTypeDef
- CriteriaBlockForJobOutputTypeDef
- CriteriaBlockForJobTypeDef
- JobScopingBlockOutputTypeDef
- JobScopingBlockTypeDef
- BucketMetadataTypeDef
- S3BucketTypeDef
- CustomDataIdentifiersTypeDef
- SensitiveDataItemTypeDef
- SearchResourcesBucketCriteriaTypeDef
- FindingActorTypeDef
- S3BucketCriteriaForJobOutputTypeDef
- S3BucketCriteriaForJobTypeDef
- ScopingOutputTypeDef
- ScopingTypeDef
- DescribeBucketsResponseTypeDef
- ResourcesAffectedTypeDef
- ClassificationResultTypeDef
- SearchResourcesRequestPaginateTypeDef
- SearchResourcesRequestTypeDef
- PolicyDetailsTypeDef
- JobSummaryTypeDef
- S3JobDefinitionOutputTypeDef
- S3JobDefinitionTypeDef
- ClassificationDetailsTypeDef
- ListClassificationJobsResponseTypeDef
- DescribeClassificationJobResponseTypeDef
- S3JobDefinitionUnionTypeDef
- FindingTypeDef
- CreateClassificationJobRequestTypeDef
- GetFindingsResponseTypeDef