Macie2 module#
Index > Macie2
Auto-generated documentation for Macie2 type annotations stubs module mypy-boto3-macie2.
How to install#
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 boto3-stubs
for Macie2
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[macie2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[macie2]'
# standalone installation
python -m pip install mypy-boto3-macie2
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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 mypy_boto3_macie2.paginator import DescribeBucketsPaginator
def get_describe_buckets_paginator() -> DescribeBucketsPaginator:
return Session().client("macie2").get_paginator("describe_buckets"))
- DescribeBucketsPaginator
- GetUsageStatisticsPaginator
- ListAllowListsPaginator
- ListClassificationJobsPaginator
- ListClassificationScopesPaginator
- ListCustomDataIdentifiersPaginator
- ListFindingsPaginator
- ListFindingsFiltersPaginator
- 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 mypy_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 schemas.
# AdminStatusType usage example
from mypy_boto3_macie2.literals import AdminStatusType
def get_value() -> AdminStatusType:
return "DISABLING_IN_PROGRESS"
- AdminStatusType
- AllowListStatusCodeType
- AllowsUnencryptedObjectUploadsType
- 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
- ListClassificationJobsPaginatorName
- ListClassificationScopesPaginatorName
- ListCustomDataIdentifiersPaginatorName
- ListFindingsFiltersPaginatorName
- ListFindingsPaginatorName
- ListInvitationsPaginatorName
- ListJobsFilterKeyType
- ListJobsSortAttributeNameType
- ListManagedDataIdentifiersPaginatorName
- ListMembersPaginatorName
- ListOrganizationAdminAccountsPaginatorName
- ListResourceProfileArtifactsPaginatorName
- ListResourceProfileDetectionsPaginatorName
- ListSensitivityInspectionTemplatesPaginatorName
- MacieStatusType
- ManagedDataIdentifierSelectorType
- OrderByType
- OriginTypeType
- RelationshipStatusType
- 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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AcceptInvitationRequestRequestTypeDef usage example
from mypy_boto3_macie2.type_defs import AcceptInvitationRequestRequestTypeDef
def get_value() -> AcceptInvitationRequestRequestTypeDef:
return {
"invitationId": ...,
}
- AcceptInvitationRequestRequestTypeDef
- AccessControlListTypeDef
- AccountDetailTypeDef
- BlockPublicAccessTypeDef
- AdminAccountTypeDef
- S3WordsListTypeDef
- AllowListStatusTypeDef
- AllowListSummaryTypeDef
- ApiCallDetailsTypeDef
- AwsAccountTypeDef
- AwsServiceTypeDef
- BatchGetCustomDataIdentifierSummaryTypeDef
- BatchGetCustomDataIdentifiersRequestRequestTypeDef
- BucketCountByEffectivePermissionTypeDef
- BucketCountByEncryptionTypeTypeDef
- BucketCountBySharedAccessTypeTypeDef
- BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef
- BucketCriteriaAdditionalPropertiesTypeDef
- BucketPolicyTypeDef
- BucketServerSideEncryptionTypeDef
- JobDetailsTypeDef
- KeyValuePairTypeDef
- ObjectCountByEncryptionTypeTypeDef
- ObjectLevelStatisticsTypeDef
- ReplicationDetailsTypeDef
- BucketSortCriteriaTypeDef
- SensitivityAggregationsTypeDef
- CellTypeDef
- S3DestinationTypeDef
- ClassificationResultStatusTypeDef
- ClassificationScopeSummaryTypeDef
- CreateAllowListResponseTypeDef
- CreateClassificationJobResponseTypeDef
- SeverityLevelTypeDef
- CreateCustomDataIdentifierResponseTypeDef
- CreateFindingsFilterResponseTypeDef
- CreateInvitationsRequestRequestTypeDef
- UnprocessedAccountTypeDef
- CreateMemberResponseTypeDef
- CreateSampleFindingsRequestRequestTypeDef
- SimpleCriterionForJobTypeDef
- CriterionAdditionalPropertiesTypeDef
- CustomDataIdentifierSummaryTypeDef
- DeclineInvitationsRequestRequestTypeDef
- DeleteAllowListRequestRequestTypeDef
- DeleteCustomDataIdentifierRequestRequestTypeDef
- DeleteFindingsFilterRequestRequestTypeDef
- DeleteInvitationsRequestRequestTypeDef
- DeleteMemberRequestRequestTypeDef
- DescribeClassificationJobRequestRequestTypeDef
- LastRunErrorStatusTypeDef
- StatisticsTypeDef
- UserPausedDetailsTypeDef
- DescribeOrganizationConfigurationResponseTypeDef
- DetectedDataDetailsTypeDef
- DetectionTypeDef
- DisableOrganizationAdminAccountRequestRequestTypeDef
- DisassociateMemberRequestRequestTypeDef
- DomainDetailsTypeDef
- EnableMacieRequestRequestTypeDef
- EnableOrganizationAdminAccountRequestRequestTypeDef
- FindingStatisticsSortCriteriaTypeDef
- SeverityTypeDef
- FindingsFilterListItemTypeDef
- InvitationTypeDef
- GetAllowListRequestRequestTypeDef
- GetAutomatedDiscoveryConfigurationResponseTypeDef
- GetBucketStatisticsRequestRequestTypeDef
- GetClassificationScopeRequestRequestTypeDef
- GetCustomDataIdentifierRequestRequestTypeDef
- GroupCountTypeDef
- GetFindingsFilterRequestRequestTypeDef
- SecurityHubConfigurationTypeDef
- SortCriteriaTypeDef
- GetInvitationsCountResponseTypeDef
- GetMacieSessionResponseTypeDef
- GetMemberRequestRequestTypeDef
- GetMemberResponseTypeDef
- GetResourceProfileRequestRequestTypeDef
- ResourceStatisticsTypeDef
- RevealConfigurationTypeDef
- GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef
- GetSensitiveDataOccurrencesAvailabilityResponseTypeDef
- WaiterConfigTypeDef
- GetSensitiveDataOccurrencesRequestRequestTypeDef
- GetSensitivityInspectionTemplateRequestRequestTypeDef
- SensitivityInspectionTemplateExcludesTypeDef
- SensitivityInspectionTemplateIncludesTypeDef
- UsageStatisticsFilterTypeDef
- UsageStatisticsSortByTypeDef
- GetUsageTotalsRequestRequestTypeDef
- UsageTotalTypeDef
- IamUserTypeDef
- IpCityTypeDef
- IpCountryTypeDef
- IpGeoLocationTypeDef
- IpOwnerTypeDef
- MonthlyScheduleTypeDef
- WeeklyScheduleTypeDef
- SimpleScopeTermTypeDef
- S3BucketDefinitionForJobTypeDef
- ListAllowListsRequestListAllowListsPaginateTypeDef
- ListAllowListsRequestRequestTypeDef
- ListJobsSortCriteriaTypeDef
- ListClassificationScopesRequestListClassificationScopesPaginateTypeDef
- ListClassificationScopesRequestRequestTypeDef
- ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef
- ListCustomDataIdentifiersRequestRequestTypeDef
- ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef
- ListFindingsFiltersRequestRequestTypeDef
- ListFindingsResponseTypeDef
- ListInvitationsRequestListInvitationsPaginateTypeDef
- ListInvitationsRequestRequestTypeDef
- ListJobsFilterTermTypeDef
- ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef
- ListManagedDataIdentifiersRequestRequestTypeDef
- ManagedDataIdentifierSummaryTypeDef
- ListMembersRequestListMembersPaginateTypeDef
- ListMembersRequestRequestTypeDef
- MemberTypeDef
- ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef
- ListOrganizationAdminAccountsRequestRequestTypeDef
- ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef
- ListResourceProfileArtifactsRequestRequestTypeDef
- ResourceProfileArtifactTypeDef
- ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef
- ListResourceProfileDetectionsRequestRequestTypeDef
- ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef
- ListSensitivityInspectionTemplatesRequestRequestTypeDef
- SensitivityInspectionTemplatesEntryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- RangeTypeDef
- RecordTypeDef
- PaginatorConfigTypeDef
- ResponseMetadataTypeDef
- S3BucketOwnerTypeDef
- ServerSideEncryptionTypeDef
- S3ClassificationScopeExclusionTypeDef
- S3ClassificationScopeExclusionUpdateTypeDef
- SearchResourcesSimpleCriterionTypeDef
- SearchResourcesSortCriteriaTypeDef
- SearchResourcesTagCriterionPairTypeDef
- ServiceLimitTypeDef
- SessionContextAttributesTypeDef
- SessionIssuerTypeDef
- SuppressDataIdentifierTypeDef
- TagCriterionPairForJobTypeDef
- TagResourceRequestRequestTypeDef
- TagValuePairTypeDef
- TestCustomDataIdentifierRequestRequestTypeDef
- TestCustomDataIdentifierResponseTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAllowListResponseTypeDef
- UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef
- UpdateClassificationJobRequestRequestTypeDef
- UpdateFindingsFilterResponseTypeDef
- UpdateMacieSessionRequestRequestTypeDef
- UpdateMemberSessionRequestRequestTypeDef
- UpdateOrganizationConfigurationRequestRequestTypeDef
- UpdateResourceProfileRequestRequestTypeDef
- UserIdentityRootTypeDef
- CreateMemberRequestRequestTypeDef
- AccountLevelPermissionsTypeDef
- ListOrganizationAdminAccountsResponseTypeDef
- AllowListCriteriaTypeDef
- ListAllowListsResponseTypeDef
- FindingActionTypeDef
- BatchGetCustomDataIdentifiersResponseTypeDef
- BucketLevelPermissionsTypeDef
- MatchingBucketTypeDef
- DescribeBucketsRequestDescribeBucketsPaginateTypeDef
- DescribeBucketsRequestRequestTypeDef
- BucketStatisticsBySensitivityTypeDef
- ClassificationExportConfigurationTypeDef
- ListClassificationScopesResponseTypeDef
- CreateCustomDataIdentifierRequestRequestTypeDef
- GetCustomDataIdentifierResponseTypeDef
- CreateInvitationsResponseTypeDef
- DeclineInvitationsResponseTypeDef
- DeleteInvitationsResponseTypeDef
- FindingCriteriaTypeDef
- ListCustomDataIdentifiersResponseTypeDef
- GetSensitiveDataOccurrencesResponseTypeDef
- ListResourceProfileDetectionsResponseTypeDef
- ListFindingsFiltersResponseTypeDef
- GetAdministratorAccountResponseTypeDef
- GetMasterAccountResponseTypeDef
- ListInvitationsResponseTypeDef
- GetFindingStatisticsResponseTypeDef
- GetFindingsPublicationConfigurationResponseTypeDef
- PutFindingsPublicationConfigurationRequestRequestTypeDef
- GetFindingsRequestRequestTypeDef
- GetResourceProfileResponseTypeDef
- GetRevealConfigurationResponseTypeDef
- UpdateRevealConfigurationRequestRequestTypeDef
- UpdateRevealConfigurationResponseTypeDef
- GetSensitiveDataOccurrencesRequestFindingRevealedWaitTypeDef
- GetSensitivityInspectionTemplateResponseTypeDef
- UpdateSensitivityInspectionTemplateRequestRequestTypeDef
- GetUsageStatisticsRequestGetUsageStatisticsPaginateTypeDef
- GetUsageStatisticsRequestRequestTypeDef
- GetUsageTotalsResponseTypeDef
- IpAddressDetailsTypeDef
- JobScheduleFrequencyTypeDef
- ListJobsFilterCriteriaTypeDef
- ListManagedDataIdentifiersResponseTypeDef
- ListMembersResponseTypeDef
- ListResourceProfileArtifactsResponseTypeDef
- ListSensitivityInspectionTemplatesResponseTypeDef
- PageTypeDef
- S3ObjectTypeDef
- S3ClassificationScopeTypeDef
- S3ClassificationScopeUpdateTypeDef
- SearchResourcesTagCriterionTypeDef
- UsageByAccountTypeDef
- SessionContextTypeDef
- UpdateResourceProfileDetectionsRequestRequestTypeDef
- TagCriterionForJobTypeDef
- TagScopeTermTypeDef
- CreateAllowListRequestRequestTypeDef
- GetAllowListResponseTypeDef
- UpdateAllowListRequestRequestTypeDef
- BucketPermissionConfigurationTypeDef
- MatchingResourceTypeDef
- GetBucketStatisticsResponseTypeDef
- GetClassificationExportConfigurationResponseTypeDef
- PutClassificationExportConfigurationRequestRequestTypeDef
- PutClassificationExportConfigurationResponseTypeDef
- CreateFindingsFilterRequestRequestTypeDef
- GetFindingStatisticsRequestRequestTypeDef
- GetFindingsFilterResponseTypeDef
- ListFindingsRequestListFindingsPaginateTypeDef
- ListFindingsRequestRequestTypeDef
- UpdateFindingsFilterRequestRequestTypeDef
- ListClassificationJobsRequestListClassificationJobsPaginateTypeDef
- ListClassificationJobsRequestRequestTypeDef
- OccurrencesTypeDef
- GetClassificationScopeResponseTypeDef
- UpdateClassificationScopeRequestRequestTypeDef
- SearchResourcesCriteriaTypeDef
- UsageRecordTypeDef
- AssumedRoleTypeDef
- FederatedUserTypeDef
- CriteriaForJobTypeDef
- JobScopeTermTypeDef
- BucketPublicAccessTypeDef
- SearchResourcesResponseTypeDef
- CustomDetectionTypeDef
- DefaultDetectionTypeDef
- SearchResourcesCriteriaBlockTypeDef
- GetUsageStatisticsResponseTypeDef
- UserIdentityTypeDef
- CriteriaBlockForJobTypeDef
- JobScopingBlockTypeDef
- BucketMetadataTypeDef
- S3BucketTypeDef
- CustomDataIdentifiersTypeDef
- SensitiveDataItemTypeDef
- SearchResourcesBucketCriteriaTypeDef
- FindingActorTypeDef
- S3BucketCriteriaForJobTypeDef
- ScopingTypeDef
- DescribeBucketsResponseTypeDef
- ResourcesAffectedTypeDef
- ClassificationResultTypeDef
- SearchResourcesRequestRequestTypeDef
- SearchResourcesRequestSearchResourcesPaginateTypeDef
- PolicyDetailsTypeDef
- JobSummaryTypeDef
- S3JobDefinitionTypeDef
- ClassificationDetailsTypeDef
- ListClassificationJobsResponseTypeDef
- CreateClassificationJobRequestRequestTypeDef
- DescribeClassificationJobResponseTypeDef
- FindingTypeDef
- GetFindingsResponseTypeDef