diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 10:05:29 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 10:05:29 +0000 |
| commit | a2aaf8d74b65e3b23d64d38d99bfbb1c5d3954ef (patch) | |
| tree | d822c1326a166cf7ab71737f51458711a4450a50 | |
| parent | 43827ba84a90b2ffa7c0cd30f1609bc7eaf07e2b (diff) | |
automatic import of python-mypy-boto3-macie2
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mypy-boto3-macie2.spec | 2485 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 2487 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-macie2-1.26.84.tar.gz diff --git a/python-mypy-boto3-macie2.spec b/python-mypy-boto3-macie2.spec new file mode 100644 index 0000000..7c68b24 --- /dev/null +++ b/python-mypy-boto3-macie2.spec @@ -0,0 +1,2485 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-macie2 +Version: 1.26.84 +Release: 1 +Summary: Type annotations for boto3.Macie2 1.26.84 service generated with mypy-boto3-builder 7.12.5 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9e/b7/712837df9571a78784f9f7433f83b70a7d223793e3e1c54c4d6181056610/mypy-boto3-macie2-1.26.84.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-macie2"></a> + +# mypy-boto3-macie2 + +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-macie2) + + + +Type annotations for +[boto3.Macie2 1.26.84](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/macie2.html#Macie2) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-macie2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-macie2](#mypy-boto3-macie2) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Macie2`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Macie2` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-macie2 +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[macie2]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[macie2]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`Macie2Client` provides annotations for `boto3.client("macie2")`. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client + +client: Macie2Client = Session().client("macie2") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_macie2.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.paginator import ( + DescribeBucketsPaginator, + GetUsageStatisticsPaginator, + ListAllowListsPaginator, + ListClassificationJobsPaginator, + ListClassificationScopesPaginator, + ListCustomDataIdentifiersPaginator, + ListFindingsPaginator, + ListFindingsFiltersPaginator, + ListInvitationsPaginator, + ListManagedDataIdentifiersPaginator, + ListMembersPaginator, + ListOrganizationAdminAccountsPaginator, + ListResourceProfileArtifactsPaginator, + ListResourceProfileDetectionsPaginator, + ListSensitivityInspectionTemplatesPaginator, + SearchResourcesPaginator, +) + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_buckets_paginator: DescribeBucketsPaginator = client.get_paginator("describe_buckets") +get_usage_statistics_paginator: GetUsageStatisticsPaginator = client.get_paginator( + "get_usage_statistics" +) +list_allow_lists_paginator: ListAllowListsPaginator = client.get_paginator("list_allow_lists") +list_classification_jobs_paginator: ListClassificationJobsPaginator = client.get_paginator( + "list_classification_jobs" +) +list_classification_scopes_paginator: ListClassificationScopesPaginator = client.get_paginator( + "list_classification_scopes" +) +list_custom_data_identifiers_paginator: ListCustomDataIdentifiersPaginator = client.get_paginator( + "list_custom_data_identifiers" +) +list_findings_paginator: ListFindingsPaginator = client.get_paginator("list_findings") +list_findings_filters_paginator: ListFindingsFiltersPaginator = client.get_paginator( + "list_findings_filters" +) +list_invitations_paginator: ListInvitationsPaginator = client.get_paginator("list_invitations") +list_managed_data_identifiers_paginator: ListManagedDataIdentifiersPaginator = client.get_paginator( + "list_managed_data_identifiers" +) +list_members_paginator: ListMembersPaginator = client.get_paginator("list_members") +list_organization_admin_accounts_paginator: ListOrganizationAdminAccountsPaginator = ( + client.get_paginator("list_organization_admin_accounts") +) +list_resource_profile_artifacts_paginator: ListResourceProfileArtifactsPaginator = ( + client.get_paginator("list_resource_profile_artifacts") +) +list_resource_profile_detections_paginator: ListResourceProfileDetectionsPaginator = ( + client.get_paginator("list_resource_profile_detections") +) +list_sensitivity_inspection_templates_paginator: ListSensitivityInspectionTemplatesPaginator = ( + client.get_paginator("list_sensitivity_inspection_templates") +) +search_resources_paginator: SearchResourcesPaginator = client.get_paginator("search_resources") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_macie2.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.waiter import FindingRevealedWaiter + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +finding_revealed_waiter: FindingRevealedWaiter = client.get_waiter("finding_revealed") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_macie2.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_macie2.literals import ( + 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, +) + + +def check_value(value: AdminStatusType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_macie2.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_macie2.type_defs import ( + AcceptInvitationRequestRequestTypeDef, + AccessControlListTypeDef, + AccountDetailTypeDef, + BlockPublicAccessTypeDef, + AdminAccountTypeDef, + S3WordsListTypeDef, + AllowListStatusTypeDef, + AllowListSummaryTypeDef, + ApiCallDetailsTypeDef, + AwsAccountTypeDef, + AwsServiceTypeDef, + BatchGetCustomDataIdentifierSummaryTypeDef, + BatchGetCustomDataIdentifiersRequestRequestTypeDef, + ResponseMetadataTypeDef, + BucketCountByEffectivePermissionTypeDef, + BucketCountByEncryptionTypeTypeDef, + BucketCountBySharedAccessTypeTypeDef, + BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef, + BucketCriteriaAdditionalPropertiesTypeDef, + BucketPolicyTypeDef, + BucketServerSideEncryptionTypeDef, + JobDetailsTypeDef, + KeyValuePairTypeDef, + ObjectCountByEncryptionTypeTypeDef, + ObjectLevelStatisticsTypeDef, + ReplicationDetailsTypeDef, + BucketSortCriteriaTypeDef, + SensitivityAggregationsTypeDef, + CellTypeDef, + S3DestinationTypeDef, + ClassificationResultStatusTypeDef, + ClassificationScopeSummaryTypeDef, + SeverityLevelTypeDef, + CreateInvitationsRequestRequestTypeDef, + UnprocessedAccountTypeDef, + CreateSampleFindingsRequestRequestTypeDef, + SimpleCriterionForJobTypeDef, + CriterionAdditionalPropertiesTypeDef, + CustomDataIdentifierSummaryTypeDef, + DeclineInvitationsRequestRequestTypeDef, + DeleteAllowListRequestRequestTypeDef, + DeleteCustomDataIdentifierRequestRequestTypeDef, + DeleteFindingsFilterRequestRequestTypeDef, + DeleteInvitationsRequestRequestTypeDef, + DeleteMemberRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeClassificationJobRequestRequestTypeDef, + LastRunErrorStatusTypeDef, + StatisticsTypeDef, + UserPausedDetailsTypeDef, + DetectedDataDetailsTypeDef, + DetectionTypeDef, + DisableOrganizationAdminAccountRequestRequestTypeDef, + DisassociateMemberRequestRequestTypeDef, + DomainDetailsTypeDef, + EnableMacieRequestRequestTypeDef, + EnableOrganizationAdminAccountRequestRequestTypeDef, + FindingStatisticsSortCriteriaTypeDef, + SeverityTypeDef, + FindingsFilterListItemTypeDef, + InvitationTypeDef, + GetAllowListRequestRequestTypeDef, + GetBucketStatisticsRequestRequestTypeDef, + GetClassificationScopeRequestRequestTypeDef, + GetCustomDataIdentifierRequestRequestTypeDef, + GroupCountTypeDef, + GetFindingsFilterRequestRequestTypeDef, + SecurityHubConfigurationTypeDef, + SortCriteriaTypeDef, + GetMemberRequestRequestTypeDef, + GetResourceProfileRequestRequestTypeDef, + ResourceStatisticsTypeDef, + RevealConfigurationTypeDef, + GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef, + WaiterConfigTypeDef, + GetSensitiveDataOccurrencesRequestRequestTypeDef, + GetSensitivityInspectionTemplateRequestRequestTypeDef, + SensitivityInspectionTemplateExcludesTypeDef, + SensitivityInspectionTemplateIncludesTypeDef, + UsageStatisticsFilterTypeDef, + UsageStatisticsSortByTypeDef, + GetUsageTotalsRequestRequestTypeDef, + UsageTotalTypeDef, + IamUserTypeDef, + IpCityTypeDef, + IpCountryTypeDef, + IpGeoLocationTypeDef, + IpOwnerTypeDef, + MonthlyScheduleTypeDef, + WeeklyScheduleTypeDef, + SimpleScopeTermTypeDef, + S3BucketDefinitionForJobTypeDef, + ListAllowListsRequestRequestTypeDef, + ListJobsSortCriteriaTypeDef, + ListClassificationScopesRequestRequestTypeDef, + ListCustomDataIdentifiersRequestRequestTypeDef, + ListFindingsFiltersRequestRequestTypeDef, + ListInvitationsRequestRequestTypeDef, + ListJobsFilterTermTypeDef, + ListManagedDataIdentifiersRequestRequestTypeDef, + ManagedDataIdentifierSummaryTypeDef, + ListMembersRequestRequestTypeDef, + MemberTypeDef, + ListOrganizationAdminAccountsRequestRequestTypeDef, + ListResourceProfileArtifactsRequestRequestTypeDef, + ResourceProfileArtifactTypeDef, + ListResourceProfileDetectionsRequestRequestTypeDef, + ListSensitivityInspectionTemplatesRequestRequestTypeDef, + SensitivityInspectionTemplatesEntryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + RangeTypeDef, + RecordTypeDef, + S3BucketOwnerTypeDef, + ServerSideEncryptionTypeDef, + S3ClassificationScopeExclusionTypeDef, + S3ClassificationScopeExclusionUpdateTypeDef, + SearchResourcesSimpleCriterionTypeDef, + SearchResourcesSortCriteriaTypeDef, + SearchResourcesTagCriterionPairTypeDef, + ServiceLimitTypeDef, + SessionContextAttributesTypeDef, + SessionIssuerTypeDef, + SuppressDataIdentifierTypeDef, + TagCriterionPairForJobTypeDef, + TagResourceRequestRequestTypeDef, + TagValuePairTypeDef, + TestCustomDataIdentifierRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef, + UpdateClassificationJobRequestRequestTypeDef, + UpdateMacieSessionRequestRequestTypeDef, + UpdateMemberSessionRequestRequestTypeDef, + UpdateOrganizationConfigurationRequestRequestTypeDef, + UpdateResourceProfileRequestRequestTypeDef, + UserIdentityRootTypeDef, + CreateMemberRequestRequestTypeDef, + AccountLevelPermissionsTypeDef, + AllowListCriteriaTypeDef, + FindingActionTypeDef, + BatchGetCustomDataIdentifiersResponseTypeDef, + CreateAllowListResponseTypeDef, + CreateClassificationJobResponseTypeDef, + CreateCustomDataIdentifierResponseTypeDef, + CreateFindingsFilterResponseTypeDef, + CreateMemberResponseTypeDef, + DescribeOrganizationConfigurationResponseTypeDef, + GetAutomatedDiscoveryConfigurationResponseTypeDef, + GetInvitationsCountResponseTypeDef, + GetMacieSessionResponseTypeDef, + GetMemberResponseTypeDef, + GetSensitiveDataOccurrencesAvailabilityResponseTypeDef, + ListAllowListsResponseTypeDef, + ListFindingsResponseTypeDef, + ListOrganizationAdminAccountsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + TestCustomDataIdentifierResponseTypeDef, + UpdateAllowListResponseTypeDef, + UpdateFindingsFilterResponseTypeDef, + BucketLevelPermissionsTypeDef, + MatchingBucketTypeDef, + DescribeBucketsRequestRequestTypeDef, + BucketStatisticsBySensitivityTypeDef, + ClassificationExportConfigurationTypeDef, + ListClassificationScopesResponseTypeDef, + CreateCustomDataIdentifierRequestRequestTypeDef, + GetCustomDataIdentifierResponseTypeDef, + CreateInvitationsResponseTypeDef, + DeclineInvitationsResponseTypeDef, + DeleteInvitationsResponseTypeDef, + FindingCriteriaTypeDef, + ListCustomDataIdentifiersResponseTypeDef, + DescribeBucketsRequestDescribeBucketsPaginateTypeDef, + ListAllowListsRequestListAllowListsPaginateTypeDef, + ListClassificationScopesRequestListClassificationScopesPaginateTypeDef, + ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef, + ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef, + ListInvitationsRequestListInvitationsPaginateTypeDef, + ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef, + ListMembersRequestListMembersPaginateTypeDef, + ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef, + ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef, + ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef, + ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef, + 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, +) + + +def get_structure() -> AcceptInvitationRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-macie2` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-macie2 +Summary: Type annotations for boto3.Macie2 1.26.84 service generated with mypy-boto3-builder 7.12.5 +Provides: python-mypy-boto3-macie2 +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-macie2 +<a id="mypy-boto3-macie2"></a> + +# mypy-boto3-macie2 + +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-macie2) + + + +Type annotations for +[boto3.Macie2 1.26.84](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/macie2.html#Macie2) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-macie2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-macie2](#mypy-boto3-macie2) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Macie2`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Macie2` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-macie2 +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[macie2]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[macie2]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`Macie2Client` provides annotations for `boto3.client("macie2")`. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client + +client: Macie2Client = Session().client("macie2") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_macie2.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.paginator import ( + DescribeBucketsPaginator, + GetUsageStatisticsPaginator, + ListAllowListsPaginator, + ListClassificationJobsPaginator, + ListClassificationScopesPaginator, + ListCustomDataIdentifiersPaginator, + ListFindingsPaginator, + ListFindingsFiltersPaginator, + ListInvitationsPaginator, + ListManagedDataIdentifiersPaginator, + ListMembersPaginator, + ListOrganizationAdminAccountsPaginator, + ListResourceProfileArtifactsPaginator, + ListResourceProfileDetectionsPaginator, + ListSensitivityInspectionTemplatesPaginator, + SearchResourcesPaginator, +) + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_buckets_paginator: DescribeBucketsPaginator = client.get_paginator("describe_buckets") +get_usage_statistics_paginator: GetUsageStatisticsPaginator = client.get_paginator( + "get_usage_statistics" +) +list_allow_lists_paginator: ListAllowListsPaginator = client.get_paginator("list_allow_lists") +list_classification_jobs_paginator: ListClassificationJobsPaginator = client.get_paginator( + "list_classification_jobs" +) +list_classification_scopes_paginator: ListClassificationScopesPaginator = client.get_paginator( + "list_classification_scopes" +) +list_custom_data_identifiers_paginator: ListCustomDataIdentifiersPaginator = client.get_paginator( + "list_custom_data_identifiers" +) +list_findings_paginator: ListFindingsPaginator = client.get_paginator("list_findings") +list_findings_filters_paginator: ListFindingsFiltersPaginator = client.get_paginator( + "list_findings_filters" +) +list_invitations_paginator: ListInvitationsPaginator = client.get_paginator("list_invitations") +list_managed_data_identifiers_paginator: ListManagedDataIdentifiersPaginator = client.get_paginator( + "list_managed_data_identifiers" +) +list_members_paginator: ListMembersPaginator = client.get_paginator("list_members") +list_organization_admin_accounts_paginator: ListOrganizationAdminAccountsPaginator = ( + client.get_paginator("list_organization_admin_accounts") +) +list_resource_profile_artifacts_paginator: ListResourceProfileArtifactsPaginator = ( + client.get_paginator("list_resource_profile_artifacts") +) +list_resource_profile_detections_paginator: ListResourceProfileDetectionsPaginator = ( + client.get_paginator("list_resource_profile_detections") +) +list_sensitivity_inspection_templates_paginator: ListSensitivityInspectionTemplatesPaginator = ( + client.get_paginator("list_sensitivity_inspection_templates") +) +search_resources_paginator: SearchResourcesPaginator = client.get_paginator("search_resources") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_macie2.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.waiter import FindingRevealedWaiter + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +finding_revealed_waiter: FindingRevealedWaiter = client.get_waiter("finding_revealed") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_macie2.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_macie2.literals import ( + 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, +) + + +def check_value(value: AdminStatusType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_macie2.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_macie2.type_defs import ( + AcceptInvitationRequestRequestTypeDef, + AccessControlListTypeDef, + AccountDetailTypeDef, + BlockPublicAccessTypeDef, + AdminAccountTypeDef, + S3WordsListTypeDef, + AllowListStatusTypeDef, + AllowListSummaryTypeDef, + ApiCallDetailsTypeDef, + AwsAccountTypeDef, + AwsServiceTypeDef, + BatchGetCustomDataIdentifierSummaryTypeDef, + BatchGetCustomDataIdentifiersRequestRequestTypeDef, + ResponseMetadataTypeDef, + BucketCountByEffectivePermissionTypeDef, + BucketCountByEncryptionTypeTypeDef, + BucketCountBySharedAccessTypeTypeDef, + BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef, + BucketCriteriaAdditionalPropertiesTypeDef, + BucketPolicyTypeDef, + BucketServerSideEncryptionTypeDef, + JobDetailsTypeDef, + KeyValuePairTypeDef, + ObjectCountByEncryptionTypeTypeDef, + ObjectLevelStatisticsTypeDef, + ReplicationDetailsTypeDef, + BucketSortCriteriaTypeDef, + SensitivityAggregationsTypeDef, + CellTypeDef, + S3DestinationTypeDef, + ClassificationResultStatusTypeDef, + ClassificationScopeSummaryTypeDef, + SeverityLevelTypeDef, + CreateInvitationsRequestRequestTypeDef, + UnprocessedAccountTypeDef, + CreateSampleFindingsRequestRequestTypeDef, + SimpleCriterionForJobTypeDef, + CriterionAdditionalPropertiesTypeDef, + CustomDataIdentifierSummaryTypeDef, + DeclineInvitationsRequestRequestTypeDef, + DeleteAllowListRequestRequestTypeDef, + DeleteCustomDataIdentifierRequestRequestTypeDef, + DeleteFindingsFilterRequestRequestTypeDef, + DeleteInvitationsRequestRequestTypeDef, + DeleteMemberRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeClassificationJobRequestRequestTypeDef, + LastRunErrorStatusTypeDef, + StatisticsTypeDef, + UserPausedDetailsTypeDef, + DetectedDataDetailsTypeDef, + DetectionTypeDef, + DisableOrganizationAdminAccountRequestRequestTypeDef, + DisassociateMemberRequestRequestTypeDef, + DomainDetailsTypeDef, + EnableMacieRequestRequestTypeDef, + EnableOrganizationAdminAccountRequestRequestTypeDef, + FindingStatisticsSortCriteriaTypeDef, + SeverityTypeDef, + FindingsFilterListItemTypeDef, + InvitationTypeDef, + GetAllowListRequestRequestTypeDef, + GetBucketStatisticsRequestRequestTypeDef, + GetClassificationScopeRequestRequestTypeDef, + GetCustomDataIdentifierRequestRequestTypeDef, + GroupCountTypeDef, + GetFindingsFilterRequestRequestTypeDef, + SecurityHubConfigurationTypeDef, + SortCriteriaTypeDef, + GetMemberRequestRequestTypeDef, + GetResourceProfileRequestRequestTypeDef, + ResourceStatisticsTypeDef, + RevealConfigurationTypeDef, + GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef, + WaiterConfigTypeDef, + GetSensitiveDataOccurrencesRequestRequestTypeDef, + GetSensitivityInspectionTemplateRequestRequestTypeDef, + SensitivityInspectionTemplateExcludesTypeDef, + SensitivityInspectionTemplateIncludesTypeDef, + UsageStatisticsFilterTypeDef, + UsageStatisticsSortByTypeDef, + GetUsageTotalsRequestRequestTypeDef, + UsageTotalTypeDef, + IamUserTypeDef, + IpCityTypeDef, + IpCountryTypeDef, + IpGeoLocationTypeDef, + IpOwnerTypeDef, + MonthlyScheduleTypeDef, + WeeklyScheduleTypeDef, + SimpleScopeTermTypeDef, + S3BucketDefinitionForJobTypeDef, + ListAllowListsRequestRequestTypeDef, + ListJobsSortCriteriaTypeDef, + ListClassificationScopesRequestRequestTypeDef, + ListCustomDataIdentifiersRequestRequestTypeDef, + ListFindingsFiltersRequestRequestTypeDef, + ListInvitationsRequestRequestTypeDef, + ListJobsFilterTermTypeDef, + ListManagedDataIdentifiersRequestRequestTypeDef, + ManagedDataIdentifierSummaryTypeDef, + ListMembersRequestRequestTypeDef, + MemberTypeDef, + ListOrganizationAdminAccountsRequestRequestTypeDef, + ListResourceProfileArtifactsRequestRequestTypeDef, + ResourceProfileArtifactTypeDef, + ListResourceProfileDetectionsRequestRequestTypeDef, + ListSensitivityInspectionTemplatesRequestRequestTypeDef, + SensitivityInspectionTemplatesEntryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + RangeTypeDef, + RecordTypeDef, + S3BucketOwnerTypeDef, + ServerSideEncryptionTypeDef, + S3ClassificationScopeExclusionTypeDef, + S3ClassificationScopeExclusionUpdateTypeDef, + SearchResourcesSimpleCriterionTypeDef, + SearchResourcesSortCriteriaTypeDef, + SearchResourcesTagCriterionPairTypeDef, + ServiceLimitTypeDef, + SessionContextAttributesTypeDef, + SessionIssuerTypeDef, + SuppressDataIdentifierTypeDef, + TagCriterionPairForJobTypeDef, + TagResourceRequestRequestTypeDef, + TagValuePairTypeDef, + TestCustomDataIdentifierRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef, + UpdateClassificationJobRequestRequestTypeDef, + UpdateMacieSessionRequestRequestTypeDef, + UpdateMemberSessionRequestRequestTypeDef, + UpdateOrganizationConfigurationRequestRequestTypeDef, + UpdateResourceProfileRequestRequestTypeDef, + UserIdentityRootTypeDef, + CreateMemberRequestRequestTypeDef, + AccountLevelPermissionsTypeDef, + AllowListCriteriaTypeDef, + FindingActionTypeDef, + BatchGetCustomDataIdentifiersResponseTypeDef, + CreateAllowListResponseTypeDef, + CreateClassificationJobResponseTypeDef, + CreateCustomDataIdentifierResponseTypeDef, + CreateFindingsFilterResponseTypeDef, + CreateMemberResponseTypeDef, + DescribeOrganizationConfigurationResponseTypeDef, + GetAutomatedDiscoveryConfigurationResponseTypeDef, + GetInvitationsCountResponseTypeDef, + GetMacieSessionResponseTypeDef, + GetMemberResponseTypeDef, + GetSensitiveDataOccurrencesAvailabilityResponseTypeDef, + ListAllowListsResponseTypeDef, + ListFindingsResponseTypeDef, + ListOrganizationAdminAccountsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + TestCustomDataIdentifierResponseTypeDef, + UpdateAllowListResponseTypeDef, + UpdateFindingsFilterResponseTypeDef, + BucketLevelPermissionsTypeDef, + MatchingBucketTypeDef, + DescribeBucketsRequestRequestTypeDef, + BucketStatisticsBySensitivityTypeDef, + ClassificationExportConfigurationTypeDef, + ListClassificationScopesResponseTypeDef, + CreateCustomDataIdentifierRequestRequestTypeDef, + GetCustomDataIdentifierResponseTypeDef, + CreateInvitationsResponseTypeDef, + DeclineInvitationsResponseTypeDef, + DeleteInvitationsResponseTypeDef, + FindingCriteriaTypeDef, + ListCustomDataIdentifiersResponseTypeDef, + DescribeBucketsRequestDescribeBucketsPaginateTypeDef, + ListAllowListsRequestListAllowListsPaginateTypeDef, + ListClassificationScopesRequestListClassificationScopesPaginateTypeDef, + ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef, + ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef, + ListInvitationsRequestListInvitationsPaginateTypeDef, + ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef, + ListMembersRequestListMembersPaginateTypeDef, + ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef, + ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef, + ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef, + ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef, + 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, +) + + +def get_structure() -> AcceptInvitationRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-macie2` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-macie2 +Provides: python3-mypy-boto3-macie2-doc +%description help +<a id="mypy-boto3-macie2"></a> + +# mypy-boto3-macie2 + +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://pypi.org/project/mypy-boto3-macie2) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-macie2) + + + +Type annotations for +[boto3.Macie2 1.26.84](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/macie2.html#Macie2) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.5](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-macie2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-macie2](#mypy-boto3-macie2) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Macie2`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Macie2` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-macie2 +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[macie2]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[macie2]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[macie2]` in your environment: + +```bash +python -m pip install 'boto3-stubs[macie2]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`Macie2Client` provides annotations for `boto3.client("macie2")`. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client + +client: Macie2Client = Session().client("macie2") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_macie2.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.paginator import ( + DescribeBucketsPaginator, + GetUsageStatisticsPaginator, + ListAllowListsPaginator, + ListClassificationJobsPaginator, + ListClassificationScopesPaginator, + ListCustomDataIdentifiersPaginator, + ListFindingsPaginator, + ListFindingsFiltersPaginator, + ListInvitationsPaginator, + ListManagedDataIdentifiersPaginator, + ListMembersPaginator, + ListOrganizationAdminAccountsPaginator, + ListResourceProfileArtifactsPaginator, + ListResourceProfileDetectionsPaginator, + ListSensitivityInspectionTemplatesPaginator, + SearchResourcesPaginator, +) + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_buckets_paginator: DescribeBucketsPaginator = client.get_paginator("describe_buckets") +get_usage_statistics_paginator: GetUsageStatisticsPaginator = client.get_paginator( + "get_usage_statistics" +) +list_allow_lists_paginator: ListAllowListsPaginator = client.get_paginator("list_allow_lists") +list_classification_jobs_paginator: ListClassificationJobsPaginator = client.get_paginator( + "list_classification_jobs" +) +list_classification_scopes_paginator: ListClassificationScopesPaginator = client.get_paginator( + "list_classification_scopes" +) +list_custom_data_identifiers_paginator: ListCustomDataIdentifiersPaginator = client.get_paginator( + "list_custom_data_identifiers" +) +list_findings_paginator: ListFindingsPaginator = client.get_paginator("list_findings") +list_findings_filters_paginator: ListFindingsFiltersPaginator = client.get_paginator( + "list_findings_filters" +) +list_invitations_paginator: ListInvitationsPaginator = client.get_paginator("list_invitations") +list_managed_data_identifiers_paginator: ListManagedDataIdentifiersPaginator = client.get_paginator( + "list_managed_data_identifiers" +) +list_members_paginator: ListMembersPaginator = client.get_paginator("list_members") +list_organization_admin_accounts_paginator: ListOrganizationAdminAccountsPaginator = ( + client.get_paginator("list_organization_admin_accounts") +) +list_resource_profile_artifacts_paginator: ListResourceProfileArtifactsPaginator = ( + client.get_paginator("list_resource_profile_artifacts") +) +list_resource_profile_detections_paginator: ListResourceProfileDetectionsPaginator = ( + client.get_paginator("list_resource_profile_detections") +) +list_sensitivity_inspection_templates_paginator: ListSensitivityInspectionTemplatesPaginator = ( + client.get_paginator("list_sensitivity_inspection_templates") +) +search_resources_paginator: SearchResourcesPaginator = client.get_paginator("search_resources") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_macie2.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_macie2 import Macie2Client +from mypy_boto3_macie2.waiter import FindingRevealedWaiter + +client: Macie2Client = Session().client("macie2") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +finding_revealed_waiter: FindingRevealedWaiter = client.get_waiter("finding_revealed") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_macie2.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_macie2.literals import ( + 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, +) + + +def check_value(value: AdminStatusType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_macie2.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_macie2.type_defs import ( + AcceptInvitationRequestRequestTypeDef, + AccessControlListTypeDef, + AccountDetailTypeDef, + BlockPublicAccessTypeDef, + AdminAccountTypeDef, + S3WordsListTypeDef, + AllowListStatusTypeDef, + AllowListSummaryTypeDef, + ApiCallDetailsTypeDef, + AwsAccountTypeDef, + AwsServiceTypeDef, + BatchGetCustomDataIdentifierSummaryTypeDef, + BatchGetCustomDataIdentifiersRequestRequestTypeDef, + ResponseMetadataTypeDef, + BucketCountByEffectivePermissionTypeDef, + BucketCountByEncryptionTypeTypeDef, + BucketCountBySharedAccessTypeTypeDef, + BucketCountPolicyAllowsUnencryptedObjectUploadsTypeDef, + BucketCriteriaAdditionalPropertiesTypeDef, + BucketPolicyTypeDef, + BucketServerSideEncryptionTypeDef, + JobDetailsTypeDef, + KeyValuePairTypeDef, + ObjectCountByEncryptionTypeTypeDef, + ObjectLevelStatisticsTypeDef, + ReplicationDetailsTypeDef, + BucketSortCriteriaTypeDef, + SensitivityAggregationsTypeDef, + CellTypeDef, + S3DestinationTypeDef, + ClassificationResultStatusTypeDef, + ClassificationScopeSummaryTypeDef, + SeverityLevelTypeDef, + CreateInvitationsRequestRequestTypeDef, + UnprocessedAccountTypeDef, + CreateSampleFindingsRequestRequestTypeDef, + SimpleCriterionForJobTypeDef, + CriterionAdditionalPropertiesTypeDef, + CustomDataIdentifierSummaryTypeDef, + DeclineInvitationsRequestRequestTypeDef, + DeleteAllowListRequestRequestTypeDef, + DeleteCustomDataIdentifierRequestRequestTypeDef, + DeleteFindingsFilterRequestRequestTypeDef, + DeleteInvitationsRequestRequestTypeDef, + DeleteMemberRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeClassificationJobRequestRequestTypeDef, + LastRunErrorStatusTypeDef, + StatisticsTypeDef, + UserPausedDetailsTypeDef, + DetectedDataDetailsTypeDef, + DetectionTypeDef, + DisableOrganizationAdminAccountRequestRequestTypeDef, + DisassociateMemberRequestRequestTypeDef, + DomainDetailsTypeDef, + EnableMacieRequestRequestTypeDef, + EnableOrganizationAdminAccountRequestRequestTypeDef, + FindingStatisticsSortCriteriaTypeDef, + SeverityTypeDef, + FindingsFilterListItemTypeDef, + InvitationTypeDef, + GetAllowListRequestRequestTypeDef, + GetBucketStatisticsRequestRequestTypeDef, + GetClassificationScopeRequestRequestTypeDef, + GetCustomDataIdentifierRequestRequestTypeDef, + GroupCountTypeDef, + GetFindingsFilterRequestRequestTypeDef, + SecurityHubConfigurationTypeDef, + SortCriteriaTypeDef, + GetMemberRequestRequestTypeDef, + GetResourceProfileRequestRequestTypeDef, + ResourceStatisticsTypeDef, + RevealConfigurationTypeDef, + GetSensitiveDataOccurrencesAvailabilityRequestRequestTypeDef, + WaiterConfigTypeDef, + GetSensitiveDataOccurrencesRequestRequestTypeDef, + GetSensitivityInspectionTemplateRequestRequestTypeDef, + SensitivityInspectionTemplateExcludesTypeDef, + SensitivityInspectionTemplateIncludesTypeDef, + UsageStatisticsFilterTypeDef, + UsageStatisticsSortByTypeDef, + GetUsageTotalsRequestRequestTypeDef, + UsageTotalTypeDef, + IamUserTypeDef, + IpCityTypeDef, + IpCountryTypeDef, + IpGeoLocationTypeDef, + IpOwnerTypeDef, + MonthlyScheduleTypeDef, + WeeklyScheduleTypeDef, + SimpleScopeTermTypeDef, + S3BucketDefinitionForJobTypeDef, + ListAllowListsRequestRequestTypeDef, + ListJobsSortCriteriaTypeDef, + ListClassificationScopesRequestRequestTypeDef, + ListCustomDataIdentifiersRequestRequestTypeDef, + ListFindingsFiltersRequestRequestTypeDef, + ListInvitationsRequestRequestTypeDef, + ListJobsFilterTermTypeDef, + ListManagedDataIdentifiersRequestRequestTypeDef, + ManagedDataIdentifierSummaryTypeDef, + ListMembersRequestRequestTypeDef, + MemberTypeDef, + ListOrganizationAdminAccountsRequestRequestTypeDef, + ListResourceProfileArtifactsRequestRequestTypeDef, + ResourceProfileArtifactTypeDef, + ListResourceProfileDetectionsRequestRequestTypeDef, + ListSensitivityInspectionTemplatesRequestRequestTypeDef, + SensitivityInspectionTemplatesEntryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + RangeTypeDef, + RecordTypeDef, + S3BucketOwnerTypeDef, + ServerSideEncryptionTypeDef, + S3ClassificationScopeExclusionTypeDef, + S3ClassificationScopeExclusionUpdateTypeDef, + SearchResourcesSimpleCriterionTypeDef, + SearchResourcesSortCriteriaTypeDef, + SearchResourcesTagCriterionPairTypeDef, + ServiceLimitTypeDef, + SessionContextAttributesTypeDef, + SessionIssuerTypeDef, + SuppressDataIdentifierTypeDef, + TagCriterionPairForJobTypeDef, + TagResourceRequestRequestTypeDef, + TagValuePairTypeDef, + TestCustomDataIdentifierRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAutomatedDiscoveryConfigurationRequestRequestTypeDef, + UpdateClassificationJobRequestRequestTypeDef, + UpdateMacieSessionRequestRequestTypeDef, + UpdateMemberSessionRequestRequestTypeDef, + UpdateOrganizationConfigurationRequestRequestTypeDef, + UpdateResourceProfileRequestRequestTypeDef, + UserIdentityRootTypeDef, + CreateMemberRequestRequestTypeDef, + AccountLevelPermissionsTypeDef, + AllowListCriteriaTypeDef, + FindingActionTypeDef, + BatchGetCustomDataIdentifiersResponseTypeDef, + CreateAllowListResponseTypeDef, + CreateClassificationJobResponseTypeDef, + CreateCustomDataIdentifierResponseTypeDef, + CreateFindingsFilterResponseTypeDef, + CreateMemberResponseTypeDef, + DescribeOrganizationConfigurationResponseTypeDef, + GetAutomatedDiscoveryConfigurationResponseTypeDef, + GetInvitationsCountResponseTypeDef, + GetMacieSessionResponseTypeDef, + GetMemberResponseTypeDef, + GetSensitiveDataOccurrencesAvailabilityResponseTypeDef, + ListAllowListsResponseTypeDef, + ListFindingsResponseTypeDef, + ListOrganizationAdminAccountsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + TestCustomDataIdentifierResponseTypeDef, + UpdateAllowListResponseTypeDef, + UpdateFindingsFilterResponseTypeDef, + BucketLevelPermissionsTypeDef, + MatchingBucketTypeDef, + DescribeBucketsRequestRequestTypeDef, + BucketStatisticsBySensitivityTypeDef, + ClassificationExportConfigurationTypeDef, + ListClassificationScopesResponseTypeDef, + CreateCustomDataIdentifierRequestRequestTypeDef, + GetCustomDataIdentifierResponseTypeDef, + CreateInvitationsResponseTypeDef, + DeclineInvitationsResponseTypeDef, + DeleteInvitationsResponseTypeDef, + FindingCriteriaTypeDef, + ListCustomDataIdentifiersResponseTypeDef, + DescribeBucketsRequestDescribeBucketsPaginateTypeDef, + ListAllowListsRequestListAllowListsPaginateTypeDef, + ListClassificationScopesRequestListClassificationScopesPaginateTypeDef, + ListCustomDataIdentifiersRequestListCustomDataIdentifiersPaginateTypeDef, + ListFindingsFiltersRequestListFindingsFiltersPaginateTypeDef, + ListInvitationsRequestListInvitationsPaginateTypeDef, + ListManagedDataIdentifiersRequestListManagedDataIdentifiersPaginateTypeDef, + ListMembersRequestListMembersPaginateTypeDef, + ListOrganizationAdminAccountsRequestListOrganizationAdminAccountsPaginateTypeDef, + ListResourceProfileArtifactsRequestListResourceProfileArtifactsPaginateTypeDef, + ListResourceProfileDetectionsRequestListResourceProfileDetectionsPaginateTypeDef, + ListSensitivityInspectionTemplatesRequestListSensitivityInspectionTemplatesPaginateTypeDef, + 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, +) + + +def get_structure() -> AcceptInvitationRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-macie2` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_macie2/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-macie2-1.26.84 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-macie2 -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.84-1 +- Package Spec generated @@ -0,0 +1 @@ +b06d0cf3947ab526d81e49e7a3030d8c mypy-boto3-macie2-1.26.84.tar.gz |
