diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 07:33:32 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 07:33:32 +0000 |
| commit | 4f189f143eafb1e94518276c761a6c5f521af51e (patch) | |
| tree | c8d5ad52b2646ab6d6a44afee0d7a399f1597f0f | |
| parent | c6448bb277752dc5ed886417880f66b8bc7389ef (diff) | |
automatic import of python-mypy-boto3-config
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mypy-boto3-config.spec | 2668 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 2670 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-config-1.26.107.tar.gz diff --git a/python-mypy-boto3-config.spec b/python-mypy-boto3-config.spec new file mode 100644 index 0000000..a8a5c92 --- /dev/null +++ b/python-mypy-boto3-config.spec @@ -0,0 +1,2668 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-config +Version: 1.26.107 +Release: 1 +Summary: Type annotations for boto3.ConfigService 1.26.107 service generated with mypy-boto3-builder 7.14.5 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/8d/21/f758332c8eef0b83d1ddbec3465413a3759c6dac9d8d8919cd2a5e174456/mypy-boto3-config-1.26.107.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-config"></a> + +# mypy-boto3-config + +[](https://pypi.org/project/mypy-boto3-config) +[](https://pypi.org/project/mypy-boto3-config) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/) +[](https://pypistats.org/packages/mypy-boto3-config) + + + +Type annotations for +[boto3.ConfigService 1.26.107](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/config.html#ConfigService) +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.14.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-config docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-config](#mypy-boto3-config) + - [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) + - [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 `ConfigService`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `ConfigService` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[config]' + + +# 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[config]' + + +# standalone installation +python -m pip install mypy-boto3-config +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-config +``` + +<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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[config]'` +``` + +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[config]' +``` + +- 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[config]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +- 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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]'` +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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 + +`ConfigServiceClient` provides annotations for `boto3.client("config")`. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient + +client: ConfigServiceClient = Session().client("config") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_config.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient +from mypy_boto3_config.paginator import ( + DescribeAggregateComplianceByConfigRulesPaginator, + DescribeAggregateComplianceByConformancePacksPaginator, + DescribeAggregationAuthorizationsPaginator, + DescribeComplianceByConfigRulePaginator, + DescribeComplianceByResourcePaginator, + DescribeConfigRuleEvaluationStatusPaginator, + DescribeConfigRulesPaginator, + DescribeConfigurationAggregatorSourcesStatusPaginator, + DescribeConfigurationAggregatorsPaginator, + DescribeConformancePackStatusPaginator, + DescribeConformancePacksPaginator, + DescribeOrganizationConfigRuleStatusesPaginator, + DescribeOrganizationConfigRulesPaginator, + DescribeOrganizationConformancePackStatusesPaginator, + DescribeOrganizationConformancePacksPaginator, + DescribePendingAggregationRequestsPaginator, + DescribeRemediationExecutionStatusPaginator, + DescribeRetentionConfigurationsPaginator, + GetAggregateComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByResourcePaginator, + GetConformancePackComplianceSummaryPaginator, + GetOrganizationConfigRuleDetailedStatusPaginator, + GetOrganizationConformancePackDetailedStatusPaginator, + GetResourceConfigHistoryPaginator, + ListAggregateDiscoveredResourcesPaginator, + ListDiscoveredResourcesPaginator, + ListResourceEvaluationsPaginator, + ListTagsForResourcePaginator, + SelectAggregateResourceConfigPaginator, + SelectResourceConfigPaginator, +) + +client: ConfigServiceClient = Session().client("config") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_aggregate_compliance_by_config_rules_paginator: DescribeAggregateComplianceByConfigRulesPaginator = client.get_paginator( + "describe_aggregate_compliance_by_config_rules" +) +describe_aggregate_compliance_by_conformance_packs_paginator: DescribeAggregateComplianceByConformancePacksPaginator = client.get_paginator( + "describe_aggregate_compliance_by_conformance_packs" +) +describe_aggregation_authorizations_paginator: DescribeAggregationAuthorizationsPaginator = ( + client.get_paginator("describe_aggregation_authorizations") +) +describe_compliance_by_config_rule_paginator: DescribeComplianceByConfigRulePaginator = ( + client.get_paginator("describe_compliance_by_config_rule") +) +describe_compliance_by_resource_paginator: DescribeComplianceByResourcePaginator = ( + client.get_paginator("describe_compliance_by_resource") +) +describe_config_rule_evaluation_status_paginator: DescribeConfigRuleEvaluationStatusPaginator = ( + client.get_paginator("describe_config_rule_evaluation_status") +) +describe_config_rules_paginator: DescribeConfigRulesPaginator = client.get_paginator( + "describe_config_rules" +) +describe_configuration_aggregator_sources_status_paginator: DescribeConfigurationAggregatorSourcesStatusPaginator = client.get_paginator( + "describe_configuration_aggregator_sources_status" +) +describe_configuration_aggregators_paginator: DescribeConfigurationAggregatorsPaginator = ( + client.get_paginator("describe_configuration_aggregators") +) +describe_conformance_pack_status_paginator: DescribeConformancePackStatusPaginator = ( + client.get_paginator("describe_conformance_pack_status") +) +describe_conformance_packs_paginator: DescribeConformancePacksPaginator = client.get_paginator( + "describe_conformance_packs" +) +describe_organization_config_rule_statuses_paginator: DescribeOrganizationConfigRuleStatusesPaginator = client.get_paginator( + "describe_organization_config_rule_statuses" +) +describe_organization_config_rules_paginator: DescribeOrganizationConfigRulesPaginator = ( + client.get_paginator("describe_organization_config_rules") +) +describe_organization_conformance_pack_statuses_paginator: DescribeOrganizationConformancePackStatusesPaginator = client.get_paginator( + "describe_organization_conformance_pack_statuses" +) +describe_organization_conformance_packs_paginator: DescribeOrganizationConformancePacksPaginator = ( + client.get_paginator("describe_organization_conformance_packs") +) +describe_pending_aggregation_requests_paginator: DescribePendingAggregationRequestsPaginator = ( + client.get_paginator("describe_pending_aggregation_requests") +) +describe_remediation_execution_status_paginator: DescribeRemediationExecutionStatusPaginator = ( + client.get_paginator("describe_remediation_execution_status") +) +describe_retention_configurations_paginator: DescribeRetentionConfigurationsPaginator = ( + client.get_paginator("describe_retention_configurations") +) +get_aggregate_compliance_details_by_config_rule_paginator: GetAggregateComplianceDetailsByConfigRulePaginator = client.get_paginator( + "get_aggregate_compliance_details_by_config_rule" +) +get_compliance_details_by_config_rule_paginator: GetComplianceDetailsByConfigRulePaginator = ( + client.get_paginator("get_compliance_details_by_config_rule") +) +get_compliance_details_by_resource_paginator: GetComplianceDetailsByResourcePaginator = ( + client.get_paginator("get_compliance_details_by_resource") +) +get_conformance_pack_compliance_summary_paginator: GetConformancePackComplianceSummaryPaginator = ( + client.get_paginator("get_conformance_pack_compliance_summary") +) +get_organization_config_rule_detailed_status_paginator: GetOrganizationConfigRuleDetailedStatusPaginator = client.get_paginator( + "get_organization_config_rule_detailed_status" +) +get_organization_conformance_pack_detailed_status_paginator: GetOrganizationConformancePackDetailedStatusPaginator = client.get_paginator( + "get_organization_conformance_pack_detailed_status" +) +get_resource_config_history_paginator: GetResourceConfigHistoryPaginator = client.get_paginator( + "get_resource_config_history" +) +list_aggregate_discovered_resources_paginator: ListAggregateDiscoveredResourcesPaginator = ( + client.get_paginator("list_aggregate_discovered_resources") +) +list_discovered_resources_paginator: ListDiscoveredResourcesPaginator = client.get_paginator( + "list_discovered_resources" +) +list_resource_evaluations_paginator: ListResourceEvaluationsPaginator = client.get_paginator( + "list_resource_evaluations" +) +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +select_aggregate_resource_config_paginator: SelectAggregateResourceConfigPaginator = ( + client.get_paginator("select_aggregate_resource_config") +) +select_resource_config_paginator: SelectResourceConfigPaginator = client.get_paginator( + "select_resource_config" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_config.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_config.literals import ( + AggregateConformancePackComplianceSummaryGroupKeyType, + AggregatedSourceStatusTypeType, + AggregatedSourceTypeType, + ChronologicalOrderType, + ComplianceTypeType, + ConfigRuleComplianceSummaryGroupKeyType, + ConfigRuleStateType, + ConfigurationItemStatusType, + ConformancePackComplianceTypeType, + ConformancePackStateType, + DeliveryStatusType, + DescribeAggregateComplianceByConfigRulesPaginatorName, + DescribeAggregateComplianceByConformancePacksPaginatorName, + DescribeAggregationAuthorizationsPaginatorName, + DescribeComplianceByConfigRulePaginatorName, + DescribeComplianceByResourcePaginatorName, + DescribeConfigRuleEvaluationStatusPaginatorName, + DescribeConfigRulesPaginatorName, + DescribeConfigurationAggregatorSourcesStatusPaginatorName, + DescribeConfigurationAggregatorsPaginatorName, + DescribeConformancePackStatusPaginatorName, + DescribeConformancePacksPaginatorName, + DescribeOrganizationConfigRuleStatusesPaginatorName, + DescribeOrganizationConfigRulesPaginatorName, + DescribeOrganizationConformancePackStatusesPaginatorName, + DescribeOrganizationConformancePacksPaginatorName, + DescribePendingAggregationRequestsPaginatorName, + DescribeRemediationExecutionStatusPaginatorName, + DescribeRetentionConfigurationsPaginatorName, + EvaluationModeType, + EventSourceType, + GetAggregateComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByResourcePaginatorName, + GetConformancePackComplianceSummaryPaginatorName, + GetOrganizationConfigRuleDetailedStatusPaginatorName, + GetOrganizationConformancePackDetailedStatusPaginatorName, + GetResourceConfigHistoryPaginatorName, + ListAggregateDiscoveredResourcesPaginatorName, + ListDiscoveredResourcesPaginatorName, + ListResourceEvaluationsPaginatorName, + ListTagsForResourcePaginatorName, + MaximumExecutionFrequencyType, + MemberAccountRuleStatusType, + MessageTypeType, + OrganizationConfigRuleTriggerTypeNoSNType, + OrganizationConfigRuleTriggerTypeType, + OrganizationResourceDetailedStatusType, + OrganizationResourceStatusType, + OrganizationRuleStatusType, + OwnerType, + RecorderStatusType, + RemediationExecutionStateType, + RemediationExecutionStepStateType, + RemediationTargetTypeType, + ResourceConfigurationSchemaTypeType, + ResourceCountGroupKeyType, + ResourceEvaluationStatusType, + ResourceTypeType, + ResourceValueTypeType, + SelectAggregateResourceConfigPaginatorName, + SelectResourceConfigPaginatorName, + SortByType, + SortOrderType, + ConfigServiceServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AggregateConformancePackComplianceSummaryGroupKeyType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_config.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_config.type_defs import ( + AccountAggregationSourceTypeDef, + AggregateConformancePackComplianceTypeDef, + AggregateConformancePackComplianceCountTypeDef, + AggregateConformancePackComplianceFiltersTypeDef, + AggregateConformancePackComplianceSummaryFiltersTypeDef, + AggregateResourceIdentifierTypeDef, + AggregatedSourceStatusTypeDef, + AggregationAuthorizationTypeDef, + BaseConfigurationItemTypeDef, + ResponseMetadataTypeDef, + ResourceKeyTypeDef, + ComplianceContributorCountTypeDef, + ConfigExportDeliveryInfoTypeDef, + ConfigRuleComplianceFiltersTypeDef, + ConfigRuleComplianceSummaryFiltersTypeDef, + ConfigRuleEvaluationStatusTypeDef, + EvaluationModeConfigurationTypeDef, + ScopeTypeDef, + ConfigSnapshotDeliveryPropertiesTypeDef, + ConfigStreamDeliveryInfoTypeDef, + OrganizationAggregationSourceTypeDef, + RelationshipTypeDef, + ConfigurationRecorderStatusTypeDef, + RecordingGroupTypeDef, + ConformancePackComplianceFiltersTypeDef, + ConformancePackComplianceScoreTypeDef, + ConformancePackComplianceScoresFiltersTypeDef, + ConformancePackComplianceSummaryTypeDef, + ConformancePackInputParameterTypeDef, + TemplateSSMDocumentDetailsTypeDef, + ConformancePackEvaluationFiltersTypeDef, + ConformancePackRuleComplianceTypeDef, + ConformancePackStatusDetailTypeDef, + CustomPolicyDetailsTypeDef, + DeleteAggregationAuthorizationRequestRequestTypeDef, + DeleteConfigRuleRequestRequestTypeDef, + DeleteConfigurationAggregatorRequestRequestTypeDef, + DeleteConfigurationRecorderRequestRequestTypeDef, + DeleteConformancePackRequestRequestTypeDef, + DeleteDeliveryChannelRequestRequestTypeDef, + DeleteEvaluationResultsRequestRequestTypeDef, + DeleteOrganizationConfigRuleRequestRequestTypeDef, + DeleteOrganizationConformancePackRequestRequestTypeDef, + DeletePendingAggregationRequestRequestRequestTypeDef, + DeleteRemediationConfigurationRequestRequestTypeDef, + RemediationExceptionResourceKeyTypeDef, + DeleteResourceConfigRequestRequestTypeDef, + DeleteRetentionConfigurationRequestRequestTypeDef, + DeleteStoredQueryRequestRequestTypeDef, + DeliverConfigSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeAggregationAuthorizationsRequestRequestTypeDef, + DescribeComplianceByConfigRuleRequestRequestTypeDef, + DescribeComplianceByResourceRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusRequestRequestTypeDef, + DescribeConfigRulesFiltersTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef, + DescribeConfigurationAggregatorsRequestRequestTypeDef, + DescribeConfigurationRecorderStatusRequestRequestTypeDef, + DescribeConfigurationRecordersRequestRequestTypeDef, + DescribeConformancePackStatusRequestRequestTypeDef, + DescribeConformancePacksRequestRequestTypeDef, + DescribeDeliveryChannelStatusRequestRequestTypeDef, + DescribeDeliveryChannelsRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef, + OrganizationConfigRuleStatusTypeDef, + DescribeOrganizationConfigRulesRequestRequestTypeDef, + DescribeOrganizationConformancePackStatusesRequestRequestTypeDef, + OrganizationConformancePackStatusTypeDef, + DescribeOrganizationConformancePacksRequestRequestTypeDef, + DescribePendingAggregationRequestsRequestRequestTypeDef, + PendingAggregationRequestTypeDef, + DescribeRemediationConfigurationsRequestRequestTypeDef, + RemediationExceptionTypeDef, + DescribeRetentionConfigurationsRequestRequestTypeDef, + RetentionConfigurationTypeDef, + EvaluationContextTypeDef, + EvaluationResultQualifierTypeDef, + EvaluationStatusTypeDef, + EvaluationTypeDef, + SsmControlsTypeDef, + ExternalEvaluationTypeDef, + FieldInfoTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef, + ResourceCountFiltersTypeDef, + GroupedResourceCountTypeDef, + GetComplianceDetailsByConfigRuleRequestRequestTypeDef, + GetComplianceDetailsByResourceRequestRequestTypeDef, + GetComplianceSummaryByResourceTypeRequestRequestTypeDef, + GetConformancePackComplianceSummaryRequestRequestTypeDef, + GetCustomRulePolicyRequestRequestTypeDef, + GetDiscoveredResourceCountsRequestRequestTypeDef, + ResourceCountTypeDef, + StatusDetailFiltersTypeDef, + MemberAccountStatusTypeDef, + OrganizationResourceDetailedStatusFiltersTypeDef, + OrganizationConformancePackDetailedStatusTypeDef, + GetOrganizationCustomRulePolicyRequestRequestTypeDef, + GetResourceConfigHistoryRequestRequestTypeDef, + GetResourceEvaluationSummaryRequestRequestTypeDef, + ResourceDetailsTypeDef, + GetStoredQueryRequestRequestTypeDef, + StoredQueryTypeDef, + ResourceFiltersTypeDef, + ListDiscoveredResourcesRequestRequestTypeDef, + ResourceIdentifierTypeDef, + ResourceEvaluationTypeDef, + ListStoredQueriesRequestRequestTypeDef, + StoredQueryMetadataTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagTypeDef, + OrganizationCustomPolicyRuleMetadataNoPolicyTypeDef, + OrganizationCustomRuleMetadataTypeDef, + OrganizationManagedRuleMetadataTypeDef, + OrganizationCustomPolicyRuleMetadataTypeDef, + PutResourceConfigRequestRequestTypeDef, + PutRetentionConfigurationRequestRequestTypeDef, + RemediationExecutionStepTypeDef, + ResourceValueTypeDef, + StaticValueTypeDef, + TimeWindowTypeDef, + SelectAggregateResourceConfigRequestRequestTypeDef, + SelectResourceConfigRequestRequestTypeDef, + SourceDetailTypeDef, + StartConfigRulesEvaluationRequestRequestTypeDef, + StartConfigurationRecorderRequestRequestTypeDef, + StopConfigurationRecorderRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + AggregateComplianceByConformancePackTypeDef, + AggregateConformancePackComplianceSummaryTypeDef, + DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef, + GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef, + BatchGetAggregateResourceConfigRequestRequestTypeDef, + GetAggregateResourceConfigRequestRequestTypeDef, + BatchGetAggregateResourceConfigResponseTypeDef, + DeliverConfigSnapshotResponseTypeDef, + DescribeAggregationAuthorizationsResponseTypeDef, + DescribeConfigurationAggregatorSourcesStatusResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCustomRulePolicyResponseTypeDef, + GetOrganizationCustomRulePolicyResponseTypeDef, + ListAggregateDiscoveredResourcesResponseTypeDef, + PutAggregationAuthorizationResponseTypeDef, + PutConformancePackResponseTypeDef, + PutOrganizationConfigRuleResponseTypeDef, + PutOrganizationConformancePackResponseTypeDef, + PutStoredQueryResponseTypeDef, + StartResourceEvaluationResponseTypeDef, + BatchGetResourceConfigRequestRequestTypeDef, + BatchGetResourceConfigResponseTypeDef, + DescribeRemediationExecutionStatusRequestRequestTypeDef, + StartRemediationExecutionRequestRequestTypeDef, + StartRemediationExecutionResponseTypeDef, + ComplianceSummaryTypeDef, + ComplianceTypeDef, + DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef, + GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusResponseTypeDef, + DeliveryChannelTypeDef, + DeliveryChannelStatusTypeDef, + ConfigurationAggregatorTypeDef, + ConfigurationItemTypeDef, + DescribeConfigurationRecorderStatusResponseTypeDef, + ConfigurationRecorderTypeDef, + DescribeConformancePackComplianceRequestRequestTypeDef, + ListConformancePackComplianceScoresResponseTypeDef, + ListConformancePackComplianceScoresRequestRequestTypeDef, + GetConformancePackComplianceSummaryResponseTypeDef, + OrganizationConformancePackTypeDef, + PutOrganizationConformancePackRequestRequestTypeDef, + ConformancePackDetailTypeDef, + PutConformancePackRequestRequestTypeDef, + GetConformancePackComplianceDetailsRequestRequestTypeDef, + DescribeConformancePackComplianceResponseTypeDef, + DescribeConformancePackStatusResponseTypeDef, + DeleteRemediationExceptionsRequestRequestTypeDef, + DescribeRemediationExceptionsRequestRequestTypeDef, + FailedDeleteRemediationExceptionsBatchTypeDef, + PutRemediationExceptionsRequestRequestTypeDef, + DescribeAggregateComplianceByConfigRulesRequestDescribeAggregateComplianceByConfigRulesPaginateTypeDef, + DescribeAggregateComplianceByConformancePacksRequestDescribeAggregateComplianceByConformancePacksPaginateTypeDef, + DescribeAggregationAuthorizationsRequestDescribeAggregationAuthorizationsPaginateTypeDef, + DescribeComplianceByConfigRuleRequestDescribeComplianceByConfigRulePaginateTypeDef, + DescribeComplianceByResourceRequestDescribeComplianceByResourcePaginateTypeDef, + DescribeConfigRuleEvaluationStatusRequestDescribeConfigRuleEvaluationStatusPaginateTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestDescribeConfigurationAggregatorSourcesStatusPaginateTypeDef, + DescribeConfigurationAggregatorsRequestDescribeConfigurationAggregatorsPaginateTypeDef, + DescribeConformancePackStatusRequestDescribeConformancePackStatusPaginateTypeDef, + DescribeConformancePacksRequestDescribeConformancePacksPaginateTypeDef, + DescribeOrganizationConfigRuleStatusesRequestDescribeOrganizationConfigRuleStatusesPaginateTypeDef, + DescribeOrganizationConfigRulesRequestDescribeOrganizationConfigRulesPaginateTypeDef, + DescribeOrganizationConformancePackStatusesRequestDescribeOrganizationConformancePackStatusesPaginateTypeDef, + DescribeOrganizationConformancePacksRequestDescribeOrganizationConformancePacksPaginateTypeDef, + DescribePendingAggregationRequestsRequestDescribePendingAggregationRequestsPaginateTypeDef, + DescribeRemediationExecutionStatusRequestDescribeRemediationExecutionStatusPaginateTypeDef, + DescribeRetentionConfigurationsRequestDescribeRetentionConfigurationsPaginateTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestGetAggregateComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByConfigRuleRequestGetComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByResourceRequestGetComplianceDetailsByResourcePaginateTypeDef, + GetConformancePackComplianceSummaryRequestGetConformancePackComplianceSummaryPaginateTypeDef, + GetResourceConfigHistoryRequestGetResourceConfigHistoryPaginateTypeDef, + ListDiscoveredResourcesRequestListDiscoveredResourcesPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + SelectAggregateResourceConfigRequestSelectAggregateResourceConfigPaginateTypeDef, + SelectResourceConfigRequestSelectResourceConfigPaginateTypeDef, + DescribeConfigRulesRequestDescribeConfigRulesPaginateTypeDef, + DescribeConfigRulesRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesResponseTypeDef, + DescribeOrganizationConformancePackStatusesResponseTypeDef, + DescribePendingAggregationRequestsResponseTypeDef, + DescribeRemediationExceptionsResponseTypeDef, + FailedRemediationExceptionBatchTypeDef, + DescribeRetentionConfigurationsResponseTypeDef, + PutRetentionConfigurationResponseTypeDef, + EvaluationResultIdentifierTypeDef, + PutEvaluationsRequestRequestTypeDef, + PutEvaluationsResponseTypeDef, + ExecutionControlsTypeDef, + PutExternalEvaluationRequestRequestTypeDef, + QueryInfoTypeDef, + GetAggregateDiscoveredResourceCountsRequestRequestTypeDef, + GetAggregateDiscoveredResourceCountsResponseTypeDef, + GetDiscoveredResourceCountsResponseTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestGetOrganizationConfigRuleDetailedStatusPaginateTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef, + GetOrganizationConfigRuleDetailedStatusResponseTypeDef, + GetOrganizationConformancePackDetailedStatusRequestGetOrganizationConformancePackDetailedStatusPaginateTypeDef, + GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef, + GetOrganizationConformancePackDetailedStatusResponseTypeDef, + GetResourceEvaluationSummaryResponseTypeDef, + StartResourceEvaluationRequestRequestTypeDef, + GetStoredQueryResponseTypeDef, + ListAggregateDiscoveredResourcesRequestListAggregateDiscoveredResourcesPaginateTypeDef, + ListAggregateDiscoveredResourcesRequestRequestTypeDef, + ListDiscoveredResourcesResponseTypeDef, + ListResourceEvaluationsResponseTypeDef, + ListStoredQueriesResponseTypeDef, + ListTagsForResourceResponseTypeDef, + PutAggregationAuthorizationRequestRequestTypeDef, + PutConfigurationAggregatorRequestRequestTypeDef, + PutStoredQueryRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + OrganizationConfigRuleTypeDef, + PutOrganizationConfigRuleRequestRequestTypeDef, + RemediationExecutionStatusTypeDef, + RemediationParameterValueTypeDef, + ResourceEvaluationFiltersTypeDef, + SourceTypeDef, + DescribeAggregateComplianceByConformancePacksResponseTypeDef, + GetAggregateConformancePackComplianceSummaryResponseTypeDef, + AggregateComplianceCountTypeDef, + ComplianceSummaryByResourceTypeTypeDef, + GetComplianceSummaryByConfigRuleResponseTypeDef, + AggregateComplianceByConfigRuleTypeDef, + ComplianceByConfigRuleTypeDef, + ComplianceByResourceTypeDef, + DescribeDeliveryChannelsResponseTypeDef, + PutDeliveryChannelRequestRequestTypeDef, + DescribeDeliveryChannelStatusResponseTypeDef, + DescribeConfigurationAggregatorsResponseTypeDef, + PutConfigurationAggregatorResponseTypeDef, + GetAggregateResourceConfigResponseTypeDef, + GetResourceConfigHistoryResponseTypeDef, + DescribeConfigurationRecordersResponseTypeDef, + PutConfigurationRecorderRequestRequestTypeDef, + DescribeOrganizationConformancePacksResponseTypeDef, + DescribeConformancePacksResponseTypeDef, + DeleteRemediationExceptionsResponseTypeDef, + PutRemediationExceptionsResponseTypeDef, + AggregateEvaluationResultTypeDef, + ConformancePackEvaluationResultTypeDef, + EvaluationResultTypeDef, + SelectAggregateResourceConfigResponseTypeDef, + SelectResourceConfigResponseTypeDef, + DescribeOrganizationConfigRulesResponseTypeDef, + DescribeRemediationExecutionStatusResponseTypeDef, + RemediationConfigurationTypeDef, + ListResourceEvaluationsRequestListResourceEvaluationsPaginateTypeDef, + ListResourceEvaluationsRequestRequestTypeDef, + ConfigRuleTypeDef, + GetAggregateConfigRuleComplianceSummaryResponseTypeDef, + GetComplianceSummaryByResourceTypeResponseTypeDef, + DescribeAggregateComplianceByConfigRulesResponseTypeDef, + DescribeComplianceByConfigRuleResponseTypeDef, + DescribeComplianceByResourceResponseTypeDef, + GetAggregateComplianceDetailsByConfigRuleResponseTypeDef, + GetConformancePackComplianceDetailsResponseTypeDef, + GetComplianceDetailsByConfigRuleResponseTypeDef, + GetComplianceDetailsByResourceResponseTypeDef, + DescribeRemediationConfigurationsResponseTypeDef, + FailedRemediationBatchTypeDef, + PutRemediationConfigurationsRequestRequestTypeDef, + DescribeConfigRulesResponseTypeDef, + PutConfigRuleRequestRequestTypeDef, + PutRemediationConfigurationsResponseTypeDef, +) + + +def get_structure() -> AccountAggregationSourceTypeDef: + 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 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 `botocore` schemas. +- 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`, `aiobotocore` and `aioboto3` + 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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` 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-config` 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_config/) + +<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-config +Summary: Type annotations for boto3.ConfigService 1.26.107 service generated with mypy-boto3-builder 7.14.5 +Provides: python-mypy-boto3-config +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-config +<a id="mypy-boto3-config"></a> + +# mypy-boto3-config + +[](https://pypi.org/project/mypy-boto3-config) +[](https://pypi.org/project/mypy-boto3-config) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/) +[](https://pypistats.org/packages/mypy-boto3-config) + + + +Type annotations for +[boto3.ConfigService 1.26.107](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/config.html#ConfigService) +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.14.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-config docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-config](#mypy-boto3-config) + - [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) + - [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 `ConfigService`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `ConfigService` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[config]' + + +# 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[config]' + + +# standalone installation +python -m pip install mypy-boto3-config +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-config +``` + +<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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[config]'` +``` + +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[config]' +``` + +- 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[config]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +- 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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]'` +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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 + +`ConfigServiceClient` provides annotations for `boto3.client("config")`. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient + +client: ConfigServiceClient = Session().client("config") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_config.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient +from mypy_boto3_config.paginator import ( + DescribeAggregateComplianceByConfigRulesPaginator, + DescribeAggregateComplianceByConformancePacksPaginator, + DescribeAggregationAuthorizationsPaginator, + DescribeComplianceByConfigRulePaginator, + DescribeComplianceByResourcePaginator, + DescribeConfigRuleEvaluationStatusPaginator, + DescribeConfigRulesPaginator, + DescribeConfigurationAggregatorSourcesStatusPaginator, + DescribeConfigurationAggregatorsPaginator, + DescribeConformancePackStatusPaginator, + DescribeConformancePacksPaginator, + DescribeOrganizationConfigRuleStatusesPaginator, + DescribeOrganizationConfigRulesPaginator, + DescribeOrganizationConformancePackStatusesPaginator, + DescribeOrganizationConformancePacksPaginator, + DescribePendingAggregationRequestsPaginator, + DescribeRemediationExecutionStatusPaginator, + DescribeRetentionConfigurationsPaginator, + GetAggregateComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByResourcePaginator, + GetConformancePackComplianceSummaryPaginator, + GetOrganizationConfigRuleDetailedStatusPaginator, + GetOrganizationConformancePackDetailedStatusPaginator, + GetResourceConfigHistoryPaginator, + ListAggregateDiscoveredResourcesPaginator, + ListDiscoveredResourcesPaginator, + ListResourceEvaluationsPaginator, + ListTagsForResourcePaginator, + SelectAggregateResourceConfigPaginator, + SelectResourceConfigPaginator, +) + +client: ConfigServiceClient = Session().client("config") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_aggregate_compliance_by_config_rules_paginator: DescribeAggregateComplianceByConfigRulesPaginator = client.get_paginator( + "describe_aggregate_compliance_by_config_rules" +) +describe_aggregate_compliance_by_conformance_packs_paginator: DescribeAggregateComplianceByConformancePacksPaginator = client.get_paginator( + "describe_aggregate_compliance_by_conformance_packs" +) +describe_aggregation_authorizations_paginator: DescribeAggregationAuthorizationsPaginator = ( + client.get_paginator("describe_aggregation_authorizations") +) +describe_compliance_by_config_rule_paginator: DescribeComplianceByConfigRulePaginator = ( + client.get_paginator("describe_compliance_by_config_rule") +) +describe_compliance_by_resource_paginator: DescribeComplianceByResourcePaginator = ( + client.get_paginator("describe_compliance_by_resource") +) +describe_config_rule_evaluation_status_paginator: DescribeConfigRuleEvaluationStatusPaginator = ( + client.get_paginator("describe_config_rule_evaluation_status") +) +describe_config_rules_paginator: DescribeConfigRulesPaginator = client.get_paginator( + "describe_config_rules" +) +describe_configuration_aggregator_sources_status_paginator: DescribeConfigurationAggregatorSourcesStatusPaginator = client.get_paginator( + "describe_configuration_aggregator_sources_status" +) +describe_configuration_aggregators_paginator: DescribeConfigurationAggregatorsPaginator = ( + client.get_paginator("describe_configuration_aggregators") +) +describe_conformance_pack_status_paginator: DescribeConformancePackStatusPaginator = ( + client.get_paginator("describe_conformance_pack_status") +) +describe_conformance_packs_paginator: DescribeConformancePacksPaginator = client.get_paginator( + "describe_conformance_packs" +) +describe_organization_config_rule_statuses_paginator: DescribeOrganizationConfigRuleStatusesPaginator = client.get_paginator( + "describe_organization_config_rule_statuses" +) +describe_organization_config_rules_paginator: DescribeOrganizationConfigRulesPaginator = ( + client.get_paginator("describe_organization_config_rules") +) +describe_organization_conformance_pack_statuses_paginator: DescribeOrganizationConformancePackStatusesPaginator = client.get_paginator( + "describe_organization_conformance_pack_statuses" +) +describe_organization_conformance_packs_paginator: DescribeOrganizationConformancePacksPaginator = ( + client.get_paginator("describe_organization_conformance_packs") +) +describe_pending_aggregation_requests_paginator: DescribePendingAggregationRequestsPaginator = ( + client.get_paginator("describe_pending_aggregation_requests") +) +describe_remediation_execution_status_paginator: DescribeRemediationExecutionStatusPaginator = ( + client.get_paginator("describe_remediation_execution_status") +) +describe_retention_configurations_paginator: DescribeRetentionConfigurationsPaginator = ( + client.get_paginator("describe_retention_configurations") +) +get_aggregate_compliance_details_by_config_rule_paginator: GetAggregateComplianceDetailsByConfigRulePaginator = client.get_paginator( + "get_aggregate_compliance_details_by_config_rule" +) +get_compliance_details_by_config_rule_paginator: GetComplianceDetailsByConfigRulePaginator = ( + client.get_paginator("get_compliance_details_by_config_rule") +) +get_compliance_details_by_resource_paginator: GetComplianceDetailsByResourcePaginator = ( + client.get_paginator("get_compliance_details_by_resource") +) +get_conformance_pack_compliance_summary_paginator: GetConformancePackComplianceSummaryPaginator = ( + client.get_paginator("get_conformance_pack_compliance_summary") +) +get_organization_config_rule_detailed_status_paginator: GetOrganizationConfigRuleDetailedStatusPaginator = client.get_paginator( + "get_organization_config_rule_detailed_status" +) +get_organization_conformance_pack_detailed_status_paginator: GetOrganizationConformancePackDetailedStatusPaginator = client.get_paginator( + "get_organization_conformance_pack_detailed_status" +) +get_resource_config_history_paginator: GetResourceConfigHistoryPaginator = client.get_paginator( + "get_resource_config_history" +) +list_aggregate_discovered_resources_paginator: ListAggregateDiscoveredResourcesPaginator = ( + client.get_paginator("list_aggregate_discovered_resources") +) +list_discovered_resources_paginator: ListDiscoveredResourcesPaginator = client.get_paginator( + "list_discovered_resources" +) +list_resource_evaluations_paginator: ListResourceEvaluationsPaginator = client.get_paginator( + "list_resource_evaluations" +) +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +select_aggregate_resource_config_paginator: SelectAggregateResourceConfigPaginator = ( + client.get_paginator("select_aggregate_resource_config") +) +select_resource_config_paginator: SelectResourceConfigPaginator = client.get_paginator( + "select_resource_config" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_config.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_config.literals import ( + AggregateConformancePackComplianceSummaryGroupKeyType, + AggregatedSourceStatusTypeType, + AggregatedSourceTypeType, + ChronologicalOrderType, + ComplianceTypeType, + ConfigRuleComplianceSummaryGroupKeyType, + ConfigRuleStateType, + ConfigurationItemStatusType, + ConformancePackComplianceTypeType, + ConformancePackStateType, + DeliveryStatusType, + DescribeAggregateComplianceByConfigRulesPaginatorName, + DescribeAggregateComplianceByConformancePacksPaginatorName, + DescribeAggregationAuthorizationsPaginatorName, + DescribeComplianceByConfigRulePaginatorName, + DescribeComplianceByResourcePaginatorName, + DescribeConfigRuleEvaluationStatusPaginatorName, + DescribeConfigRulesPaginatorName, + DescribeConfigurationAggregatorSourcesStatusPaginatorName, + DescribeConfigurationAggregatorsPaginatorName, + DescribeConformancePackStatusPaginatorName, + DescribeConformancePacksPaginatorName, + DescribeOrganizationConfigRuleStatusesPaginatorName, + DescribeOrganizationConfigRulesPaginatorName, + DescribeOrganizationConformancePackStatusesPaginatorName, + DescribeOrganizationConformancePacksPaginatorName, + DescribePendingAggregationRequestsPaginatorName, + DescribeRemediationExecutionStatusPaginatorName, + DescribeRetentionConfigurationsPaginatorName, + EvaluationModeType, + EventSourceType, + GetAggregateComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByResourcePaginatorName, + GetConformancePackComplianceSummaryPaginatorName, + GetOrganizationConfigRuleDetailedStatusPaginatorName, + GetOrganizationConformancePackDetailedStatusPaginatorName, + GetResourceConfigHistoryPaginatorName, + ListAggregateDiscoveredResourcesPaginatorName, + ListDiscoveredResourcesPaginatorName, + ListResourceEvaluationsPaginatorName, + ListTagsForResourcePaginatorName, + MaximumExecutionFrequencyType, + MemberAccountRuleStatusType, + MessageTypeType, + OrganizationConfigRuleTriggerTypeNoSNType, + OrganizationConfigRuleTriggerTypeType, + OrganizationResourceDetailedStatusType, + OrganizationResourceStatusType, + OrganizationRuleStatusType, + OwnerType, + RecorderStatusType, + RemediationExecutionStateType, + RemediationExecutionStepStateType, + RemediationTargetTypeType, + ResourceConfigurationSchemaTypeType, + ResourceCountGroupKeyType, + ResourceEvaluationStatusType, + ResourceTypeType, + ResourceValueTypeType, + SelectAggregateResourceConfigPaginatorName, + SelectResourceConfigPaginatorName, + SortByType, + SortOrderType, + ConfigServiceServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AggregateConformancePackComplianceSummaryGroupKeyType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_config.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_config.type_defs import ( + AccountAggregationSourceTypeDef, + AggregateConformancePackComplianceTypeDef, + AggregateConformancePackComplianceCountTypeDef, + AggregateConformancePackComplianceFiltersTypeDef, + AggregateConformancePackComplianceSummaryFiltersTypeDef, + AggregateResourceIdentifierTypeDef, + AggregatedSourceStatusTypeDef, + AggregationAuthorizationTypeDef, + BaseConfigurationItemTypeDef, + ResponseMetadataTypeDef, + ResourceKeyTypeDef, + ComplianceContributorCountTypeDef, + ConfigExportDeliveryInfoTypeDef, + ConfigRuleComplianceFiltersTypeDef, + ConfigRuleComplianceSummaryFiltersTypeDef, + ConfigRuleEvaluationStatusTypeDef, + EvaluationModeConfigurationTypeDef, + ScopeTypeDef, + ConfigSnapshotDeliveryPropertiesTypeDef, + ConfigStreamDeliveryInfoTypeDef, + OrganizationAggregationSourceTypeDef, + RelationshipTypeDef, + ConfigurationRecorderStatusTypeDef, + RecordingGroupTypeDef, + ConformancePackComplianceFiltersTypeDef, + ConformancePackComplianceScoreTypeDef, + ConformancePackComplianceScoresFiltersTypeDef, + ConformancePackComplianceSummaryTypeDef, + ConformancePackInputParameterTypeDef, + TemplateSSMDocumentDetailsTypeDef, + ConformancePackEvaluationFiltersTypeDef, + ConformancePackRuleComplianceTypeDef, + ConformancePackStatusDetailTypeDef, + CustomPolicyDetailsTypeDef, + DeleteAggregationAuthorizationRequestRequestTypeDef, + DeleteConfigRuleRequestRequestTypeDef, + DeleteConfigurationAggregatorRequestRequestTypeDef, + DeleteConfigurationRecorderRequestRequestTypeDef, + DeleteConformancePackRequestRequestTypeDef, + DeleteDeliveryChannelRequestRequestTypeDef, + DeleteEvaluationResultsRequestRequestTypeDef, + DeleteOrganizationConfigRuleRequestRequestTypeDef, + DeleteOrganizationConformancePackRequestRequestTypeDef, + DeletePendingAggregationRequestRequestRequestTypeDef, + DeleteRemediationConfigurationRequestRequestTypeDef, + RemediationExceptionResourceKeyTypeDef, + DeleteResourceConfigRequestRequestTypeDef, + DeleteRetentionConfigurationRequestRequestTypeDef, + DeleteStoredQueryRequestRequestTypeDef, + DeliverConfigSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeAggregationAuthorizationsRequestRequestTypeDef, + DescribeComplianceByConfigRuleRequestRequestTypeDef, + DescribeComplianceByResourceRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusRequestRequestTypeDef, + DescribeConfigRulesFiltersTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef, + DescribeConfigurationAggregatorsRequestRequestTypeDef, + DescribeConfigurationRecorderStatusRequestRequestTypeDef, + DescribeConfigurationRecordersRequestRequestTypeDef, + DescribeConformancePackStatusRequestRequestTypeDef, + DescribeConformancePacksRequestRequestTypeDef, + DescribeDeliveryChannelStatusRequestRequestTypeDef, + DescribeDeliveryChannelsRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef, + OrganizationConfigRuleStatusTypeDef, + DescribeOrganizationConfigRulesRequestRequestTypeDef, + DescribeOrganizationConformancePackStatusesRequestRequestTypeDef, + OrganizationConformancePackStatusTypeDef, + DescribeOrganizationConformancePacksRequestRequestTypeDef, + DescribePendingAggregationRequestsRequestRequestTypeDef, + PendingAggregationRequestTypeDef, + DescribeRemediationConfigurationsRequestRequestTypeDef, + RemediationExceptionTypeDef, + DescribeRetentionConfigurationsRequestRequestTypeDef, + RetentionConfigurationTypeDef, + EvaluationContextTypeDef, + EvaluationResultQualifierTypeDef, + EvaluationStatusTypeDef, + EvaluationTypeDef, + SsmControlsTypeDef, + ExternalEvaluationTypeDef, + FieldInfoTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef, + ResourceCountFiltersTypeDef, + GroupedResourceCountTypeDef, + GetComplianceDetailsByConfigRuleRequestRequestTypeDef, + GetComplianceDetailsByResourceRequestRequestTypeDef, + GetComplianceSummaryByResourceTypeRequestRequestTypeDef, + GetConformancePackComplianceSummaryRequestRequestTypeDef, + GetCustomRulePolicyRequestRequestTypeDef, + GetDiscoveredResourceCountsRequestRequestTypeDef, + ResourceCountTypeDef, + StatusDetailFiltersTypeDef, + MemberAccountStatusTypeDef, + OrganizationResourceDetailedStatusFiltersTypeDef, + OrganizationConformancePackDetailedStatusTypeDef, + GetOrganizationCustomRulePolicyRequestRequestTypeDef, + GetResourceConfigHistoryRequestRequestTypeDef, + GetResourceEvaluationSummaryRequestRequestTypeDef, + ResourceDetailsTypeDef, + GetStoredQueryRequestRequestTypeDef, + StoredQueryTypeDef, + ResourceFiltersTypeDef, + ListDiscoveredResourcesRequestRequestTypeDef, + ResourceIdentifierTypeDef, + ResourceEvaluationTypeDef, + ListStoredQueriesRequestRequestTypeDef, + StoredQueryMetadataTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagTypeDef, + OrganizationCustomPolicyRuleMetadataNoPolicyTypeDef, + OrganizationCustomRuleMetadataTypeDef, + OrganizationManagedRuleMetadataTypeDef, + OrganizationCustomPolicyRuleMetadataTypeDef, + PutResourceConfigRequestRequestTypeDef, + PutRetentionConfigurationRequestRequestTypeDef, + RemediationExecutionStepTypeDef, + ResourceValueTypeDef, + StaticValueTypeDef, + TimeWindowTypeDef, + SelectAggregateResourceConfigRequestRequestTypeDef, + SelectResourceConfigRequestRequestTypeDef, + SourceDetailTypeDef, + StartConfigRulesEvaluationRequestRequestTypeDef, + StartConfigurationRecorderRequestRequestTypeDef, + StopConfigurationRecorderRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + AggregateComplianceByConformancePackTypeDef, + AggregateConformancePackComplianceSummaryTypeDef, + DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef, + GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef, + BatchGetAggregateResourceConfigRequestRequestTypeDef, + GetAggregateResourceConfigRequestRequestTypeDef, + BatchGetAggregateResourceConfigResponseTypeDef, + DeliverConfigSnapshotResponseTypeDef, + DescribeAggregationAuthorizationsResponseTypeDef, + DescribeConfigurationAggregatorSourcesStatusResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCustomRulePolicyResponseTypeDef, + GetOrganizationCustomRulePolicyResponseTypeDef, + ListAggregateDiscoveredResourcesResponseTypeDef, + PutAggregationAuthorizationResponseTypeDef, + PutConformancePackResponseTypeDef, + PutOrganizationConfigRuleResponseTypeDef, + PutOrganizationConformancePackResponseTypeDef, + PutStoredQueryResponseTypeDef, + StartResourceEvaluationResponseTypeDef, + BatchGetResourceConfigRequestRequestTypeDef, + BatchGetResourceConfigResponseTypeDef, + DescribeRemediationExecutionStatusRequestRequestTypeDef, + StartRemediationExecutionRequestRequestTypeDef, + StartRemediationExecutionResponseTypeDef, + ComplianceSummaryTypeDef, + ComplianceTypeDef, + DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef, + GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusResponseTypeDef, + DeliveryChannelTypeDef, + DeliveryChannelStatusTypeDef, + ConfigurationAggregatorTypeDef, + ConfigurationItemTypeDef, + DescribeConfigurationRecorderStatusResponseTypeDef, + ConfigurationRecorderTypeDef, + DescribeConformancePackComplianceRequestRequestTypeDef, + ListConformancePackComplianceScoresResponseTypeDef, + ListConformancePackComplianceScoresRequestRequestTypeDef, + GetConformancePackComplianceSummaryResponseTypeDef, + OrganizationConformancePackTypeDef, + PutOrganizationConformancePackRequestRequestTypeDef, + ConformancePackDetailTypeDef, + PutConformancePackRequestRequestTypeDef, + GetConformancePackComplianceDetailsRequestRequestTypeDef, + DescribeConformancePackComplianceResponseTypeDef, + DescribeConformancePackStatusResponseTypeDef, + DeleteRemediationExceptionsRequestRequestTypeDef, + DescribeRemediationExceptionsRequestRequestTypeDef, + FailedDeleteRemediationExceptionsBatchTypeDef, + PutRemediationExceptionsRequestRequestTypeDef, + DescribeAggregateComplianceByConfigRulesRequestDescribeAggregateComplianceByConfigRulesPaginateTypeDef, + DescribeAggregateComplianceByConformancePacksRequestDescribeAggregateComplianceByConformancePacksPaginateTypeDef, + DescribeAggregationAuthorizationsRequestDescribeAggregationAuthorizationsPaginateTypeDef, + DescribeComplianceByConfigRuleRequestDescribeComplianceByConfigRulePaginateTypeDef, + DescribeComplianceByResourceRequestDescribeComplianceByResourcePaginateTypeDef, + DescribeConfigRuleEvaluationStatusRequestDescribeConfigRuleEvaluationStatusPaginateTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestDescribeConfigurationAggregatorSourcesStatusPaginateTypeDef, + DescribeConfigurationAggregatorsRequestDescribeConfigurationAggregatorsPaginateTypeDef, + DescribeConformancePackStatusRequestDescribeConformancePackStatusPaginateTypeDef, + DescribeConformancePacksRequestDescribeConformancePacksPaginateTypeDef, + DescribeOrganizationConfigRuleStatusesRequestDescribeOrganizationConfigRuleStatusesPaginateTypeDef, + DescribeOrganizationConfigRulesRequestDescribeOrganizationConfigRulesPaginateTypeDef, + DescribeOrganizationConformancePackStatusesRequestDescribeOrganizationConformancePackStatusesPaginateTypeDef, + DescribeOrganizationConformancePacksRequestDescribeOrganizationConformancePacksPaginateTypeDef, + DescribePendingAggregationRequestsRequestDescribePendingAggregationRequestsPaginateTypeDef, + DescribeRemediationExecutionStatusRequestDescribeRemediationExecutionStatusPaginateTypeDef, + DescribeRetentionConfigurationsRequestDescribeRetentionConfigurationsPaginateTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestGetAggregateComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByConfigRuleRequestGetComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByResourceRequestGetComplianceDetailsByResourcePaginateTypeDef, + GetConformancePackComplianceSummaryRequestGetConformancePackComplianceSummaryPaginateTypeDef, + GetResourceConfigHistoryRequestGetResourceConfigHistoryPaginateTypeDef, + ListDiscoveredResourcesRequestListDiscoveredResourcesPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + SelectAggregateResourceConfigRequestSelectAggregateResourceConfigPaginateTypeDef, + SelectResourceConfigRequestSelectResourceConfigPaginateTypeDef, + DescribeConfigRulesRequestDescribeConfigRulesPaginateTypeDef, + DescribeConfigRulesRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesResponseTypeDef, + DescribeOrganizationConformancePackStatusesResponseTypeDef, + DescribePendingAggregationRequestsResponseTypeDef, + DescribeRemediationExceptionsResponseTypeDef, + FailedRemediationExceptionBatchTypeDef, + DescribeRetentionConfigurationsResponseTypeDef, + PutRetentionConfigurationResponseTypeDef, + EvaluationResultIdentifierTypeDef, + PutEvaluationsRequestRequestTypeDef, + PutEvaluationsResponseTypeDef, + ExecutionControlsTypeDef, + PutExternalEvaluationRequestRequestTypeDef, + QueryInfoTypeDef, + GetAggregateDiscoveredResourceCountsRequestRequestTypeDef, + GetAggregateDiscoveredResourceCountsResponseTypeDef, + GetDiscoveredResourceCountsResponseTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestGetOrganizationConfigRuleDetailedStatusPaginateTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef, + GetOrganizationConfigRuleDetailedStatusResponseTypeDef, + GetOrganizationConformancePackDetailedStatusRequestGetOrganizationConformancePackDetailedStatusPaginateTypeDef, + GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef, + GetOrganizationConformancePackDetailedStatusResponseTypeDef, + GetResourceEvaluationSummaryResponseTypeDef, + StartResourceEvaluationRequestRequestTypeDef, + GetStoredQueryResponseTypeDef, + ListAggregateDiscoveredResourcesRequestListAggregateDiscoveredResourcesPaginateTypeDef, + ListAggregateDiscoveredResourcesRequestRequestTypeDef, + ListDiscoveredResourcesResponseTypeDef, + ListResourceEvaluationsResponseTypeDef, + ListStoredQueriesResponseTypeDef, + ListTagsForResourceResponseTypeDef, + PutAggregationAuthorizationRequestRequestTypeDef, + PutConfigurationAggregatorRequestRequestTypeDef, + PutStoredQueryRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + OrganizationConfigRuleTypeDef, + PutOrganizationConfigRuleRequestRequestTypeDef, + RemediationExecutionStatusTypeDef, + RemediationParameterValueTypeDef, + ResourceEvaluationFiltersTypeDef, + SourceTypeDef, + DescribeAggregateComplianceByConformancePacksResponseTypeDef, + GetAggregateConformancePackComplianceSummaryResponseTypeDef, + AggregateComplianceCountTypeDef, + ComplianceSummaryByResourceTypeTypeDef, + GetComplianceSummaryByConfigRuleResponseTypeDef, + AggregateComplianceByConfigRuleTypeDef, + ComplianceByConfigRuleTypeDef, + ComplianceByResourceTypeDef, + DescribeDeliveryChannelsResponseTypeDef, + PutDeliveryChannelRequestRequestTypeDef, + DescribeDeliveryChannelStatusResponseTypeDef, + DescribeConfigurationAggregatorsResponseTypeDef, + PutConfigurationAggregatorResponseTypeDef, + GetAggregateResourceConfigResponseTypeDef, + GetResourceConfigHistoryResponseTypeDef, + DescribeConfigurationRecordersResponseTypeDef, + PutConfigurationRecorderRequestRequestTypeDef, + DescribeOrganizationConformancePacksResponseTypeDef, + DescribeConformancePacksResponseTypeDef, + DeleteRemediationExceptionsResponseTypeDef, + PutRemediationExceptionsResponseTypeDef, + AggregateEvaluationResultTypeDef, + ConformancePackEvaluationResultTypeDef, + EvaluationResultTypeDef, + SelectAggregateResourceConfigResponseTypeDef, + SelectResourceConfigResponseTypeDef, + DescribeOrganizationConfigRulesResponseTypeDef, + DescribeRemediationExecutionStatusResponseTypeDef, + RemediationConfigurationTypeDef, + ListResourceEvaluationsRequestListResourceEvaluationsPaginateTypeDef, + ListResourceEvaluationsRequestRequestTypeDef, + ConfigRuleTypeDef, + GetAggregateConfigRuleComplianceSummaryResponseTypeDef, + GetComplianceSummaryByResourceTypeResponseTypeDef, + DescribeAggregateComplianceByConfigRulesResponseTypeDef, + DescribeComplianceByConfigRuleResponseTypeDef, + DescribeComplianceByResourceResponseTypeDef, + GetAggregateComplianceDetailsByConfigRuleResponseTypeDef, + GetConformancePackComplianceDetailsResponseTypeDef, + GetComplianceDetailsByConfigRuleResponseTypeDef, + GetComplianceDetailsByResourceResponseTypeDef, + DescribeRemediationConfigurationsResponseTypeDef, + FailedRemediationBatchTypeDef, + PutRemediationConfigurationsRequestRequestTypeDef, + DescribeConfigRulesResponseTypeDef, + PutConfigRuleRequestRequestTypeDef, + PutRemediationConfigurationsResponseTypeDef, +) + + +def get_structure() -> AccountAggregationSourceTypeDef: + 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 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 `botocore` schemas. +- 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`, `aiobotocore` and `aioboto3` + 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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` 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-config` 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_config/) + +<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-config +Provides: python3-mypy-boto3-config-doc +%description help +<a id="mypy-boto3-config"></a> + +# mypy-boto3-config + +[](https://pypi.org/project/mypy-boto3-config) +[](https://pypi.org/project/mypy-boto3-config) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/) +[](https://pypistats.org/packages/mypy-boto3-config) + + + +Type annotations for +[boto3.ConfigService 1.26.107](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/config.html#ConfigService) +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.14.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-config docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_config/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-config](#mypy-boto3-config) + - [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) + - [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 `ConfigService`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `ConfigService` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[config]' + + +# 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[config]' + + +# standalone installation +python -m pip install mypy-boto3-config +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-config +``` + +<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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[config]'` +``` + +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[config]' +``` + +- 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[config]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +- 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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]'` +``` + +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[config]` in your environment: + +```bash +python -m pip install 'boto3-stubs[config]' +``` + +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 + +`ConfigServiceClient` provides annotations for `boto3.client("config")`. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient + +client: ConfigServiceClient = Session().client("config") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_config.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_config import ConfigServiceClient +from mypy_boto3_config.paginator import ( + DescribeAggregateComplianceByConfigRulesPaginator, + DescribeAggregateComplianceByConformancePacksPaginator, + DescribeAggregationAuthorizationsPaginator, + DescribeComplianceByConfigRulePaginator, + DescribeComplianceByResourcePaginator, + DescribeConfigRuleEvaluationStatusPaginator, + DescribeConfigRulesPaginator, + DescribeConfigurationAggregatorSourcesStatusPaginator, + DescribeConfigurationAggregatorsPaginator, + DescribeConformancePackStatusPaginator, + DescribeConformancePacksPaginator, + DescribeOrganizationConfigRuleStatusesPaginator, + DescribeOrganizationConfigRulesPaginator, + DescribeOrganizationConformancePackStatusesPaginator, + DescribeOrganizationConformancePacksPaginator, + DescribePendingAggregationRequestsPaginator, + DescribeRemediationExecutionStatusPaginator, + DescribeRetentionConfigurationsPaginator, + GetAggregateComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByConfigRulePaginator, + GetComplianceDetailsByResourcePaginator, + GetConformancePackComplianceSummaryPaginator, + GetOrganizationConfigRuleDetailedStatusPaginator, + GetOrganizationConformancePackDetailedStatusPaginator, + GetResourceConfigHistoryPaginator, + ListAggregateDiscoveredResourcesPaginator, + ListDiscoveredResourcesPaginator, + ListResourceEvaluationsPaginator, + ListTagsForResourcePaginator, + SelectAggregateResourceConfigPaginator, + SelectResourceConfigPaginator, +) + +client: ConfigServiceClient = Session().client("config") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_aggregate_compliance_by_config_rules_paginator: DescribeAggregateComplianceByConfigRulesPaginator = client.get_paginator( + "describe_aggregate_compliance_by_config_rules" +) +describe_aggregate_compliance_by_conformance_packs_paginator: DescribeAggregateComplianceByConformancePacksPaginator = client.get_paginator( + "describe_aggregate_compliance_by_conformance_packs" +) +describe_aggregation_authorizations_paginator: DescribeAggregationAuthorizationsPaginator = ( + client.get_paginator("describe_aggregation_authorizations") +) +describe_compliance_by_config_rule_paginator: DescribeComplianceByConfigRulePaginator = ( + client.get_paginator("describe_compliance_by_config_rule") +) +describe_compliance_by_resource_paginator: DescribeComplianceByResourcePaginator = ( + client.get_paginator("describe_compliance_by_resource") +) +describe_config_rule_evaluation_status_paginator: DescribeConfigRuleEvaluationStatusPaginator = ( + client.get_paginator("describe_config_rule_evaluation_status") +) +describe_config_rules_paginator: DescribeConfigRulesPaginator = client.get_paginator( + "describe_config_rules" +) +describe_configuration_aggregator_sources_status_paginator: DescribeConfigurationAggregatorSourcesStatusPaginator = client.get_paginator( + "describe_configuration_aggregator_sources_status" +) +describe_configuration_aggregators_paginator: DescribeConfigurationAggregatorsPaginator = ( + client.get_paginator("describe_configuration_aggregators") +) +describe_conformance_pack_status_paginator: DescribeConformancePackStatusPaginator = ( + client.get_paginator("describe_conformance_pack_status") +) +describe_conformance_packs_paginator: DescribeConformancePacksPaginator = client.get_paginator( + "describe_conformance_packs" +) +describe_organization_config_rule_statuses_paginator: DescribeOrganizationConfigRuleStatusesPaginator = client.get_paginator( + "describe_organization_config_rule_statuses" +) +describe_organization_config_rules_paginator: DescribeOrganizationConfigRulesPaginator = ( + client.get_paginator("describe_organization_config_rules") +) +describe_organization_conformance_pack_statuses_paginator: DescribeOrganizationConformancePackStatusesPaginator = client.get_paginator( + "describe_organization_conformance_pack_statuses" +) +describe_organization_conformance_packs_paginator: DescribeOrganizationConformancePacksPaginator = ( + client.get_paginator("describe_organization_conformance_packs") +) +describe_pending_aggregation_requests_paginator: DescribePendingAggregationRequestsPaginator = ( + client.get_paginator("describe_pending_aggregation_requests") +) +describe_remediation_execution_status_paginator: DescribeRemediationExecutionStatusPaginator = ( + client.get_paginator("describe_remediation_execution_status") +) +describe_retention_configurations_paginator: DescribeRetentionConfigurationsPaginator = ( + client.get_paginator("describe_retention_configurations") +) +get_aggregate_compliance_details_by_config_rule_paginator: GetAggregateComplianceDetailsByConfigRulePaginator = client.get_paginator( + "get_aggregate_compliance_details_by_config_rule" +) +get_compliance_details_by_config_rule_paginator: GetComplianceDetailsByConfigRulePaginator = ( + client.get_paginator("get_compliance_details_by_config_rule") +) +get_compliance_details_by_resource_paginator: GetComplianceDetailsByResourcePaginator = ( + client.get_paginator("get_compliance_details_by_resource") +) +get_conformance_pack_compliance_summary_paginator: GetConformancePackComplianceSummaryPaginator = ( + client.get_paginator("get_conformance_pack_compliance_summary") +) +get_organization_config_rule_detailed_status_paginator: GetOrganizationConfigRuleDetailedStatusPaginator = client.get_paginator( + "get_organization_config_rule_detailed_status" +) +get_organization_conformance_pack_detailed_status_paginator: GetOrganizationConformancePackDetailedStatusPaginator = client.get_paginator( + "get_organization_conformance_pack_detailed_status" +) +get_resource_config_history_paginator: GetResourceConfigHistoryPaginator = client.get_paginator( + "get_resource_config_history" +) +list_aggregate_discovered_resources_paginator: ListAggregateDiscoveredResourcesPaginator = ( + client.get_paginator("list_aggregate_discovered_resources") +) +list_discovered_resources_paginator: ListDiscoveredResourcesPaginator = client.get_paginator( + "list_discovered_resources" +) +list_resource_evaluations_paginator: ListResourceEvaluationsPaginator = client.get_paginator( + "list_resource_evaluations" +) +list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator( + "list_tags_for_resource" +) +select_aggregate_resource_config_paginator: SelectAggregateResourceConfigPaginator = ( + client.get_paginator("select_aggregate_resource_config") +) +select_resource_config_paginator: SelectResourceConfigPaginator = client.get_paginator( + "select_resource_config" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_config.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_config.literals import ( + AggregateConformancePackComplianceSummaryGroupKeyType, + AggregatedSourceStatusTypeType, + AggregatedSourceTypeType, + ChronologicalOrderType, + ComplianceTypeType, + ConfigRuleComplianceSummaryGroupKeyType, + ConfigRuleStateType, + ConfigurationItemStatusType, + ConformancePackComplianceTypeType, + ConformancePackStateType, + DeliveryStatusType, + DescribeAggregateComplianceByConfigRulesPaginatorName, + DescribeAggregateComplianceByConformancePacksPaginatorName, + DescribeAggregationAuthorizationsPaginatorName, + DescribeComplianceByConfigRulePaginatorName, + DescribeComplianceByResourcePaginatorName, + DescribeConfigRuleEvaluationStatusPaginatorName, + DescribeConfigRulesPaginatorName, + DescribeConfigurationAggregatorSourcesStatusPaginatorName, + DescribeConfigurationAggregatorsPaginatorName, + DescribeConformancePackStatusPaginatorName, + DescribeConformancePacksPaginatorName, + DescribeOrganizationConfigRuleStatusesPaginatorName, + DescribeOrganizationConfigRulesPaginatorName, + DescribeOrganizationConformancePackStatusesPaginatorName, + DescribeOrganizationConformancePacksPaginatorName, + DescribePendingAggregationRequestsPaginatorName, + DescribeRemediationExecutionStatusPaginatorName, + DescribeRetentionConfigurationsPaginatorName, + EvaluationModeType, + EventSourceType, + GetAggregateComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByConfigRulePaginatorName, + GetComplianceDetailsByResourcePaginatorName, + GetConformancePackComplianceSummaryPaginatorName, + GetOrganizationConfigRuleDetailedStatusPaginatorName, + GetOrganizationConformancePackDetailedStatusPaginatorName, + GetResourceConfigHistoryPaginatorName, + ListAggregateDiscoveredResourcesPaginatorName, + ListDiscoveredResourcesPaginatorName, + ListResourceEvaluationsPaginatorName, + ListTagsForResourcePaginatorName, + MaximumExecutionFrequencyType, + MemberAccountRuleStatusType, + MessageTypeType, + OrganizationConfigRuleTriggerTypeNoSNType, + OrganizationConfigRuleTriggerTypeType, + OrganizationResourceDetailedStatusType, + OrganizationResourceStatusType, + OrganizationRuleStatusType, + OwnerType, + RecorderStatusType, + RemediationExecutionStateType, + RemediationExecutionStepStateType, + RemediationTargetTypeType, + ResourceConfigurationSchemaTypeType, + ResourceCountGroupKeyType, + ResourceEvaluationStatusType, + ResourceTypeType, + ResourceValueTypeType, + SelectAggregateResourceConfigPaginatorName, + SelectResourceConfigPaginatorName, + SortByType, + SortOrderType, + ConfigServiceServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AggregateConformancePackComplianceSummaryGroupKeyType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_config.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_config.type_defs import ( + AccountAggregationSourceTypeDef, + AggregateConformancePackComplianceTypeDef, + AggregateConformancePackComplianceCountTypeDef, + AggregateConformancePackComplianceFiltersTypeDef, + AggregateConformancePackComplianceSummaryFiltersTypeDef, + AggregateResourceIdentifierTypeDef, + AggregatedSourceStatusTypeDef, + AggregationAuthorizationTypeDef, + BaseConfigurationItemTypeDef, + ResponseMetadataTypeDef, + ResourceKeyTypeDef, + ComplianceContributorCountTypeDef, + ConfigExportDeliveryInfoTypeDef, + ConfigRuleComplianceFiltersTypeDef, + ConfigRuleComplianceSummaryFiltersTypeDef, + ConfigRuleEvaluationStatusTypeDef, + EvaluationModeConfigurationTypeDef, + ScopeTypeDef, + ConfigSnapshotDeliveryPropertiesTypeDef, + ConfigStreamDeliveryInfoTypeDef, + OrganizationAggregationSourceTypeDef, + RelationshipTypeDef, + ConfigurationRecorderStatusTypeDef, + RecordingGroupTypeDef, + ConformancePackComplianceFiltersTypeDef, + ConformancePackComplianceScoreTypeDef, + ConformancePackComplianceScoresFiltersTypeDef, + ConformancePackComplianceSummaryTypeDef, + ConformancePackInputParameterTypeDef, + TemplateSSMDocumentDetailsTypeDef, + ConformancePackEvaluationFiltersTypeDef, + ConformancePackRuleComplianceTypeDef, + ConformancePackStatusDetailTypeDef, + CustomPolicyDetailsTypeDef, + DeleteAggregationAuthorizationRequestRequestTypeDef, + DeleteConfigRuleRequestRequestTypeDef, + DeleteConfigurationAggregatorRequestRequestTypeDef, + DeleteConfigurationRecorderRequestRequestTypeDef, + DeleteConformancePackRequestRequestTypeDef, + DeleteDeliveryChannelRequestRequestTypeDef, + DeleteEvaluationResultsRequestRequestTypeDef, + DeleteOrganizationConfigRuleRequestRequestTypeDef, + DeleteOrganizationConformancePackRequestRequestTypeDef, + DeletePendingAggregationRequestRequestRequestTypeDef, + DeleteRemediationConfigurationRequestRequestTypeDef, + RemediationExceptionResourceKeyTypeDef, + DeleteResourceConfigRequestRequestTypeDef, + DeleteRetentionConfigurationRequestRequestTypeDef, + DeleteStoredQueryRequestRequestTypeDef, + DeliverConfigSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + DescribeAggregationAuthorizationsRequestRequestTypeDef, + DescribeComplianceByConfigRuleRequestRequestTypeDef, + DescribeComplianceByResourceRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusRequestRequestTypeDef, + DescribeConfigRulesFiltersTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef, + DescribeConfigurationAggregatorsRequestRequestTypeDef, + DescribeConfigurationRecorderStatusRequestRequestTypeDef, + DescribeConfigurationRecordersRequestRequestTypeDef, + DescribeConformancePackStatusRequestRequestTypeDef, + DescribeConformancePacksRequestRequestTypeDef, + DescribeDeliveryChannelStatusRequestRequestTypeDef, + DescribeDeliveryChannelsRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef, + OrganizationConfigRuleStatusTypeDef, + DescribeOrganizationConfigRulesRequestRequestTypeDef, + DescribeOrganizationConformancePackStatusesRequestRequestTypeDef, + OrganizationConformancePackStatusTypeDef, + DescribeOrganizationConformancePacksRequestRequestTypeDef, + DescribePendingAggregationRequestsRequestRequestTypeDef, + PendingAggregationRequestTypeDef, + DescribeRemediationConfigurationsRequestRequestTypeDef, + RemediationExceptionTypeDef, + DescribeRetentionConfigurationsRequestRequestTypeDef, + RetentionConfigurationTypeDef, + EvaluationContextTypeDef, + EvaluationResultQualifierTypeDef, + EvaluationStatusTypeDef, + EvaluationTypeDef, + SsmControlsTypeDef, + ExternalEvaluationTypeDef, + FieldInfoTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef, + ResourceCountFiltersTypeDef, + GroupedResourceCountTypeDef, + GetComplianceDetailsByConfigRuleRequestRequestTypeDef, + GetComplianceDetailsByResourceRequestRequestTypeDef, + GetComplianceSummaryByResourceTypeRequestRequestTypeDef, + GetConformancePackComplianceSummaryRequestRequestTypeDef, + GetCustomRulePolicyRequestRequestTypeDef, + GetDiscoveredResourceCountsRequestRequestTypeDef, + ResourceCountTypeDef, + StatusDetailFiltersTypeDef, + MemberAccountStatusTypeDef, + OrganizationResourceDetailedStatusFiltersTypeDef, + OrganizationConformancePackDetailedStatusTypeDef, + GetOrganizationCustomRulePolicyRequestRequestTypeDef, + GetResourceConfigHistoryRequestRequestTypeDef, + GetResourceEvaluationSummaryRequestRequestTypeDef, + ResourceDetailsTypeDef, + GetStoredQueryRequestRequestTypeDef, + StoredQueryTypeDef, + ResourceFiltersTypeDef, + ListDiscoveredResourcesRequestRequestTypeDef, + ResourceIdentifierTypeDef, + ResourceEvaluationTypeDef, + ListStoredQueriesRequestRequestTypeDef, + StoredQueryMetadataTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagTypeDef, + OrganizationCustomPolicyRuleMetadataNoPolicyTypeDef, + OrganizationCustomRuleMetadataTypeDef, + OrganizationManagedRuleMetadataTypeDef, + OrganizationCustomPolicyRuleMetadataTypeDef, + PutResourceConfigRequestRequestTypeDef, + PutRetentionConfigurationRequestRequestTypeDef, + RemediationExecutionStepTypeDef, + ResourceValueTypeDef, + StaticValueTypeDef, + TimeWindowTypeDef, + SelectAggregateResourceConfigRequestRequestTypeDef, + SelectResourceConfigRequestRequestTypeDef, + SourceDetailTypeDef, + StartConfigRulesEvaluationRequestRequestTypeDef, + StartConfigurationRecorderRequestRequestTypeDef, + StopConfigurationRecorderRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + AggregateComplianceByConformancePackTypeDef, + AggregateConformancePackComplianceSummaryTypeDef, + DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef, + GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef, + BatchGetAggregateResourceConfigRequestRequestTypeDef, + GetAggregateResourceConfigRequestRequestTypeDef, + BatchGetAggregateResourceConfigResponseTypeDef, + DeliverConfigSnapshotResponseTypeDef, + DescribeAggregationAuthorizationsResponseTypeDef, + DescribeConfigurationAggregatorSourcesStatusResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCustomRulePolicyResponseTypeDef, + GetOrganizationCustomRulePolicyResponseTypeDef, + ListAggregateDiscoveredResourcesResponseTypeDef, + PutAggregationAuthorizationResponseTypeDef, + PutConformancePackResponseTypeDef, + PutOrganizationConfigRuleResponseTypeDef, + PutOrganizationConformancePackResponseTypeDef, + PutStoredQueryResponseTypeDef, + StartResourceEvaluationResponseTypeDef, + BatchGetResourceConfigRequestRequestTypeDef, + BatchGetResourceConfigResponseTypeDef, + DescribeRemediationExecutionStatusRequestRequestTypeDef, + StartRemediationExecutionRequestRequestTypeDef, + StartRemediationExecutionResponseTypeDef, + ComplianceSummaryTypeDef, + ComplianceTypeDef, + DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef, + GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef, + DescribeConfigRuleEvaluationStatusResponseTypeDef, + DeliveryChannelTypeDef, + DeliveryChannelStatusTypeDef, + ConfigurationAggregatorTypeDef, + ConfigurationItemTypeDef, + DescribeConfigurationRecorderStatusResponseTypeDef, + ConfigurationRecorderTypeDef, + DescribeConformancePackComplianceRequestRequestTypeDef, + ListConformancePackComplianceScoresResponseTypeDef, + ListConformancePackComplianceScoresRequestRequestTypeDef, + GetConformancePackComplianceSummaryResponseTypeDef, + OrganizationConformancePackTypeDef, + PutOrganizationConformancePackRequestRequestTypeDef, + ConformancePackDetailTypeDef, + PutConformancePackRequestRequestTypeDef, + GetConformancePackComplianceDetailsRequestRequestTypeDef, + DescribeConformancePackComplianceResponseTypeDef, + DescribeConformancePackStatusResponseTypeDef, + DeleteRemediationExceptionsRequestRequestTypeDef, + DescribeRemediationExceptionsRequestRequestTypeDef, + FailedDeleteRemediationExceptionsBatchTypeDef, + PutRemediationExceptionsRequestRequestTypeDef, + DescribeAggregateComplianceByConfigRulesRequestDescribeAggregateComplianceByConfigRulesPaginateTypeDef, + DescribeAggregateComplianceByConformancePacksRequestDescribeAggregateComplianceByConformancePacksPaginateTypeDef, + DescribeAggregationAuthorizationsRequestDescribeAggregationAuthorizationsPaginateTypeDef, + DescribeComplianceByConfigRuleRequestDescribeComplianceByConfigRulePaginateTypeDef, + DescribeComplianceByResourceRequestDescribeComplianceByResourcePaginateTypeDef, + DescribeConfigRuleEvaluationStatusRequestDescribeConfigRuleEvaluationStatusPaginateTypeDef, + DescribeConfigurationAggregatorSourcesStatusRequestDescribeConfigurationAggregatorSourcesStatusPaginateTypeDef, + DescribeConfigurationAggregatorsRequestDescribeConfigurationAggregatorsPaginateTypeDef, + DescribeConformancePackStatusRequestDescribeConformancePackStatusPaginateTypeDef, + DescribeConformancePacksRequestDescribeConformancePacksPaginateTypeDef, + DescribeOrganizationConfigRuleStatusesRequestDescribeOrganizationConfigRuleStatusesPaginateTypeDef, + DescribeOrganizationConfigRulesRequestDescribeOrganizationConfigRulesPaginateTypeDef, + DescribeOrganizationConformancePackStatusesRequestDescribeOrganizationConformancePackStatusesPaginateTypeDef, + DescribeOrganizationConformancePacksRequestDescribeOrganizationConformancePacksPaginateTypeDef, + DescribePendingAggregationRequestsRequestDescribePendingAggregationRequestsPaginateTypeDef, + DescribeRemediationExecutionStatusRequestDescribeRemediationExecutionStatusPaginateTypeDef, + DescribeRetentionConfigurationsRequestDescribeRetentionConfigurationsPaginateTypeDef, + GetAggregateComplianceDetailsByConfigRuleRequestGetAggregateComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByConfigRuleRequestGetComplianceDetailsByConfigRulePaginateTypeDef, + GetComplianceDetailsByResourceRequestGetComplianceDetailsByResourcePaginateTypeDef, + GetConformancePackComplianceSummaryRequestGetConformancePackComplianceSummaryPaginateTypeDef, + GetResourceConfigHistoryRequestGetResourceConfigHistoryPaginateTypeDef, + ListDiscoveredResourcesRequestListDiscoveredResourcesPaginateTypeDef, + ListTagsForResourceRequestListTagsForResourcePaginateTypeDef, + SelectAggregateResourceConfigRequestSelectAggregateResourceConfigPaginateTypeDef, + SelectResourceConfigRequestSelectResourceConfigPaginateTypeDef, + DescribeConfigRulesRequestDescribeConfigRulesPaginateTypeDef, + DescribeConfigRulesRequestRequestTypeDef, + DescribeOrganizationConfigRuleStatusesResponseTypeDef, + DescribeOrganizationConformancePackStatusesResponseTypeDef, + DescribePendingAggregationRequestsResponseTypeDef, + DescribeRemediationExceptionsResponseTypeDef, + FailedRemediationExceptionBatchTypeDef, + DescribeRetentionConfigurationsResponseTypeDef, + PutRetentionConfigurationResponseTypeDef, + EvaluationResultIdentifierTypeDef, + PutEvaluationsRequestRequestTypeDef, + PutEvaluationsResponseTypeDef, + ExecutionControlsTypeDef, + PutExternalEvaluationRequestRequestTypeDef, + QueryInfoTypeDef, + GetAggregateDiscoveredResourceCountsRequestRequestTypeDef, + GetAggregateDiscoveredResourceCountsResponseTypeDef, + GetDiscoveredResourceCountsResponseTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestGetOrganizationConfigRuleDetailedStatusPaginateTypeDef, + GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef, + GetOrganizationConfigRuleDetailedStatusResponseTypeDef, + GetOrganizationConformancePackDetailedStatusRequestGetOrganizationConformancePackDetailedStatusPaginateTypeDef, + GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef, + GetOrganizationConformancePackDetailedStatusResponseTypeDef, + GetResourceEvaluationSummaryResponseTypeDef, + StartResourceEvaluationRequestRequestTypeDef, + GetStoredQueryResponseTypeDef, + ListAggregateDiscoveredResourcesRequestListAggregateDiscoveredResourcesPaginateTypeDef, + ListAggregateDiscoveredResourcesRequestRequestTypeDef, + ListDiscoveredResourcesResponseTypeDef, + ListResourceEvaluationsResponseTypeDef, + ListStoredQueriesResponseTypeDef, + ListTagsForResourceResponseTypeDef, + PutAggregationAuthorizationRequestRequestTypeDef, + PutConfigurationAggregatorRequestRequestTypeDef, + PutStoredQueryRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + OrganizationConfigRuleTypeDef, + PutOrganizationConfigRuleRequestRequestTypeDef, + RemediationExecutionStatusTypeDef, + RemediationParameterValueTypeDef, + ResourceEvaluationFiltersTypeDef, + SourceTypeDef, + DescribeAggregateComplianceByConformancePacksResponseTypeDef, + GetAggregateConformancePackComplianceSummaryResponseTypeDef, + AggregateComplianceCountTypeDef, + ComplianceSummaryByResourceTypeTypeDef, + GetComplianceSummaryByConfigRuleResponseTypeDef, + AggregateComplianceByConfigRuleTypeDef, + ComplianceByConfigRuleTypeDef, + ComplianceByResourceTypeDef, + DescribeDeliveryChannelsResponseTypeDef, + PutDeliveryChannelRequestRequestTypeDef, + DescribeDeliveryChannelStatusResponseTypeDef, + DescribeConfigurationAggregatorsResponseTypeDef, + PutConfigurationAggregatorResponseTypeDef, + GetAggregateResourceConfigResponseTypeDef, + GetResourceConfigHistoryResponseTypeDef, + DescribeConfigurationRecordersResponseTypeDef, + PutConfigurationRecorderRequestRequestTypeDef, + DescribeOrganizationConformancePacksResponseTypeDef, + DescribeConformancePacksResponseTypeDef, + DeleteRemediationExceptionsResponseTypeDef, + PutRemediationExceptionsResponseTypeDef, + AggregateEvaluationResultTypeDef, + ConformancePackEvaluationResultTypeDef, + EvaluationResultTypeDef, + SelectAggregateResourceConfigResponseTypeDef, + SelectResourceConfigResponseTypeDef, + DescribeOrganizationConfigRulesResponseTypeDef, + DescribeRemediationExecutionStatusResponseTypeDef, + RemediationConfigurationTypeDef, + ListResourceEvaluationsRequestListResourceEvaluationsPaginateTypeDef, + ListResourceEvaluationsRequestRequestTypeDef, + ConfigRuleTypeDef, + GetAggregateConfigRuleComplianceSummaryResponseTypeDef, + GetComplianceSummaryByResourceTypeResponseTypeDef, + DescribeAggregateComplianceByConfigRulesResponseTypeDef, + DescribeComplianceByConfigRuleResponseTypeDef, + DescribeComplianceByResourceResponseTypeDef, + GetAggregateComplianceDetailsByConfigRuleResponseTypeDef, + GetConformancePackComplianceDetailsResponseTypeDef, + GetComplianceDetailsByConfigRuleResponseTypeDef, + GetComplianceDetailsByResourceResponseTypeDef, + DescribeRemediationConfigurationsResponseTypeDef, + FailedRemediationBatchTypeDef, + PutRemediationConfigurationsRequestRequestTypeDef, + DescribeConfigRulesResponseTypeDef, + PutConfigRuleRequestRequestTypeDef, + PutRemediationConfigurationsResponseTypeDef, +) + + +def get_structure() -> AccountAggregationSourceTypeDef: + 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 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 `botocore` schemas. +- 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`, `aiobotocore` and `aioboto3` + 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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` 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-config` 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_config/) + +<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-config-1.26.107 + +%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-config -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.107-1 +- Package Spec generated @@ -0,0 +1 @@ +479eaa7a089712342c9c55e1bad5056f mypy-boto3-config-1.26.107.tar.gz |