types-boto3-config

Name	types-boto3-config JSON
Version	1.35.71 JSON
	download
home_page	https://github.com/youtype/mypy_boto3_builder
Summary	Type annotations for boto3 ConfigService 1.35.71 service generated with mypy-boto3-builder 8.4.0
upload_time	2024-11-28 01:04:56
maintainer	None
docs_url	None
author	Vlad Emelianov
requires_python	>=3.8
license	MIT License
keywords	boto3 config type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <a id="types-boto3-config"></a>

# types-boto3-config

[![PyPI - types-boto3-config](https://img.shields.io/pypi/v/types-boto3-config.svg?color=blue)](https://pypi.org/project/types-boto3-config/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-config.svg?color=blue)](https://pypi.org/project/types-boto3-config/)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-config)](https://pypistats.org/packages/types-boto3-config)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[boto3 ConfigService 1.35.71](https://pypi.org/project/boto3/) 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 8.4.0](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[types-boto3](https://pypi.org/project/types-boto3/) page and in
[types-boto3-config docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/).

See how it helps you find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [types-boto3-config](#types-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)
    - [Type definitions](#type-definitions)
  - [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 `types-boto3` for `ConfigService` service.

```bash
# install with boto3 type annotations
python -m pip install 'types-boto3[config]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[config]'


# standalone installation
python -m pip install types-boto3-config
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y types-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 `types-boto3[config]` in your environment:

```bash
python -m pip install 'types-boto3[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

> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
> to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
> the issue is resolved.

> ⚠️ If you experience slow performance and high CPU usage, try to disable
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
> [pyright](https://github.com/microsoft/pyright) instead.

> ⚠️ To continue using `PyCharm` type checker, you can try to replace
> `types-boto3` with
> [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

```bash
pip uninstall types-boto3
pip install types-boto3-lite
```

Install `types-boto3[config]` in your environment:

```bash
python -m pip install 'types-boto3[config]'
```

Both type checking and code completion should now work.

<a id="emacs"></a>

### Emacs

- Install `types-boto3` with services you use in your environment:

```bash
python -m pip install 'types-boto3[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 `types-boto3`

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `types-boto3[config]` with services you use in your environment:

```bash
python -m pip install 'types-boto3[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 `types-boto3[config]` in your environment:

```bash
python -m pip install 'types-boto3[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 `types-boto3[config]` in your environment:

```bash
python -m pip install 'types-boto3[config]'
```

Optionally, you can install `types-boto3` to `typings` directory.

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 types_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

`types_boto3_config.paginator` module contains type annotations for all
paginators.

```python
from boto3.session import Session

from types_boto3_config import ConfigServiceClient
from types_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,
    ListConfigurationRecordersPaginator,
    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_configuration_recorders_paginator: ListConfigurationRecordersPaginator = client.get_paginator(
    "list_configuration_recorders"
)
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

`types_boto3_config.literals` module contains literals extracted from shapes
that can be used in user code for type checking.

Full list of `ConfigService` Literals can be found in
[docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/literals/).

```python
from types_boto3_config.literals import AggregateConformancePackComplianceSummaryGroupKeyType


def check_value(value: AggregateConformancePackComplianceSummaryGroupKeyType) -> bool: ...
```

<a id="type-definitions"></a>

### Type definitions

`types_boto3_config.type_defs` module contains structures and shapes assembled
to typed dictionaries and unions for additional type checking.

Full list of `ConfigService` TypeDefs can be found in
[docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/type_defs/).

```python
from types_boto3_config.type_defs import AccountAggregationSourceOutputTypeDef


def get_value() -> AccountAggregationSourceOutputTypeDef:
    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 [ruff](https://docs.astral.sh/ruff/) 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

`types-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/types_boto3_docs/types_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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "types-boto3-config",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "boto3 config type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": null,
    "platform": null,
    "description": "<a id=\"types-boto3-config\"></a>\n\n# types-boto3-config\n\n[![PyPI - types-boto3-config](https://img.shields.io/pypi/v/types-boto3-config.svg?color=blue)](https://pypi.org/project/types-boto3-config/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-config.svg?color=blue)](https://pypi.org/project/types-boto3-config/)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-config)](https://pypistats.org/packages/types-boto3-config)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3 ConfigService 1.35.71](https://pypi.org/project/boto3/) compatible with\n[VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 8.4.0](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[types-boto3](https://pypi.org/project/types-boto3/) page and in\n[types-boto3-config docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/).\n\nSee how it helps you find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [types-boto3-config](#types-boto3-config)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Literals](#literals)\n    - [Type definitions](#type-definitions)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `ConfigService`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-boto3` for `ConfigService` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'types-boto3[config]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-boto3-lite[config]'\n\n\n# standalone installation\npython -m pip install types-boto3-config\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y types-boto3-config\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `types-boto3[config]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\n> \u26a0\ufe0f Due to slow PyCharm performance on `Literal` overloads (issue\n> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended\n> to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until\n> the issue is resolved.\n\n> \u26a0\ufe0f If you experience slow performance and high CPU usage, try to disable\n> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or\n> [pyright](https://github.com/microsoft/pyright) instead.\n\n> \u26a0\ufe0f To continue using `PyCharm` type checker, you can try to replace\n> `types-boto3` with\n> [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):\n\n```bash\npip uninstall types-boto3\npip install types-boto3-lite\n```\n\nInstall `types-boto3[config]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\nBoth type checking and code completion should now work.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-boto3` with services you use in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed `types-boto3`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-boto3[config]` with services you use in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `types-boto3[config]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-boto3[config]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[config]'\n```\n\nOptionally, you can install `types-boto3` to `typings` directory.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`ConfigServiceClient` provides annotations for `boto3.client(\"config\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom types_boto3_config import ConfigServiceClient\n\nclient: ConfigServiceClient = Session().client(\"config\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`types_boto3_config.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom types_boto3_config import ConfigServiceClient\nfrom types_boto3_config.paginator import (\n    DescribeAggregateComplianceByConfigRulesPaginator,\n    DescribeAggregateComplianceByConformancePacksPaginator,\n    DescribeAggregationAuthorizationsPaginator,\n    DescribeComplianceByConfigRulePaginator,\n    DescribeComplianceByResourcePaginator,\n    DescribeConfigRuleEvaluationStatusPaginator,\n    DescribeConfigRulesPaginator,\n    DescribeConfigurationAggregatorSourcesStatusPaginator,\n    DescribeConfigurationAggregatorsPaginator,\n    DescribeConformancePackStatusPaginator,\n    DescribeConformancePacksPaginator,\n    DescribeOrganizationConfigRuleStatusesPaginator,\n    DescribeOrganizationConfigRulesPaginator,\n    DescribeOrganizationConformancePackStatusesPaginator,\n    DescribeOrganizationConformancePacksPaginator,\n    DescribePendingAggregationRequestsPaginator,\n    DescribeRemediationExecutionStatusPaginator,\n    DescribeRetentionConfigurationsPaginator,\n    GetAggregateComplianceDetailsByConfigRulePaginator,\n    GetComplianceDetailsByConfigRulePaginator,\n    GetComplianceDetailsByResourcePaginator,\n    GetConformancePackComplianceSummaryPaginator,\n    GetOrganizationConfigRuleDetailedStatusPaginator,\n    GetOrganizationConformancePackDetailedStatusPaginator,\n    GetResourceConfigHistoryPaginator,\n    ListAggregateDiscoveredResourcesPaginator,\n    ListConfigurationRecordersPaginator,\n    ListDiscoveredResourcesPaginator,\n    ListResourceEvaluationsPaginator,\n    ListTagsForResourcePaginator,\n    SelectAggregateResourceConfigPaginator,\n    SelectResourceConfigPaginator,\n)\n\nclient: ConfigServiceClient = Session().client(\"config\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ndescribe_aggregate_compliance_by_config_rules_paginator: DescribeAggregateComplianceByConfigRulesPaginator = client.get_paginator(\n    \"describe_aggregate_compliance_by_config_rules\"\n)\ndescribe_aggregate_compliance_by_conformance_packs_paginator: DescribeAggregateComplianceByConformancePacksPaginator = client.get_paginator(\n    \"describe_aggregate_compliance_by_conformance_packs\"\n)\ndescribe_aggregation_authorizations_paginator: DescribeAggregationAuthorizationsPaginator = (\n    client.get_paginator(\"describe_aggregation_authorizations\")\n)\ndescribe_compliance_by_config_rule_paginator: DescribeComplianceByConfigRulePaginator = (\n    client.get_paginator(\"describe_compliance_by_config_rule\")\n)\ndescribe_compliance_by_resource_paginator: DescribeComplianceByResourcePaginator = (\n    client.get_paginator(\"describe_compliance_by_resource\")\n)\ndescribe_config_rule_evaluation_status_paginator: DescribeConfigRuleEvaluationStatusPaginator = (\n    client.get_paginator(\"describe_config_rule_evaluation_status\")\n)\ndescribe_config_rules_paginator: DescribeConfigRulesPaginator = client.get_paginator(\n    \"describe_config_rules\"\n)\ndescribe_configuration_aggregator_sources_status_paginator: DescribeConfigurationAggregatorSourcesStatusPaginator = client.get_paginator(\n    \"describe_configuration_aggregator_sources_status\"\n)\ndescribe_configuration_aggregators_paginator: DescribeConfigurationAggregatorsPaginator = (\n    client.get_paginator(\"describe_configuration_aggregators\")\n)\ndescribe_conformance_pack_status_paginator: DescribeConformancePackStatusPaginator = (\n    client.get_paginator(\"describe_conformance_pack_status\")\n)\ndescribe_conformance_packs_paginator: DescribeConformancePacksPaginator = client.get_paginator(\n    \"describe_conformance_packs\"\n)\ndescribe_organization_config_rule_statuses_paginator: DescribeOrganizationConfigRuleStatusesPaginator = client.get_paginator(\n    \"describe_organization_config_rule_statuses\"\n)\ndescribe_organization_config_rules_paginator: DescribeOrganizationConfigRulesPaginator = (\n    client.get_paginator(\"describe_organization_config_rules\")\n)\ndescribe_organization_conformance_pack_statuses_paginator: DescribeOrganizationConformancePackStatusesPaginator = client.get_paginator(\n    \"describe_organization_conformance_pack_statuses\"\n)\ndescribe_organization_conformance_packs_paginator: DescribeOrganizationConformancePacksPaginator = (\n    client.get_paginator(\"describe_organization_conformance_packs\")\n)\ndescribe_pending_aggregation_requests_paginator: DescribePendingAggregationRequestsPaginator = (\n    client.get_paginator(\"describe_pending_aggregation_requests\")\n)\ndescribe_remediation_execution_status_paginator: DescribeRemediationExecutionStatusPaginator = (\n    client.get_paginator(\"describe_remediation_execution_status\")\n)\ndescribe_retention_configurations_paginator: DescribeRetentionConfigurationsPaginator = (\n    client.get_paginator(\"describe_retention_configurations\")\n)\nget_aggregate_compliance_details_by_config_rule_paginator: GetAggregateComplianceDetailsByConfigRulePaginator = client.get_paginator(\n    \"get_aggregate_compliance_details_by_config_rule\"\n)\nget_compliance_details_by_config_rule_paginator: GetComplianceDetailsByConfigRulePaginator = (\n    client.get_paginator(\"get_compliance_details_by_config_rule\")\n)\nget_compliance_details_by_resource_paginator: GetComplianceDetailsByResourcePaginator = (\n    client.get_paginator(\"get_compliance_details_by_resource\")\n)\nget_conformance_pack_compliance_summary_paginator: GetConformancePackComplianceSummaryPaginator = (\n    client.get_paginator(\"get_conformance_pack_compliance_summary\")\n)\nget_organization_config_rule_detailed_status_paginator: GetOrganizationConfigRuleDetailedStatusPaginator = client.get_paginator(\n    \"get_organization_config_rule_detailed_status\"\n)\nget_organization_conformance_pack_detailed_status_paginator: GetOrganizationConformancePackDetailedStatusPaginator = client.get_paginator(\n    \"get_organization_conformance_pack_detailed_status\"\n)\nget_resource_config_history_paginator: GetResourceConfigHistoryPaginator = client.get_paginator(\n    \"get_resource_config_history\"\n)\nlist_aggregate_discovered_resources_paginator: ListAggregateDiscoveredResourcesPaginator = (\n    client.get_paginator(\"list_aggregate_discovered_resources\")\n)\nlist_configuration_recorders_paginator: ListConfigurationRecordersPaginator = client.get_paginator(\n    \"list_configuration_recorders\"\n)\nlist_discovered_resources_paginator: ListDiscoveredResourcesPaginator = client.get_paginator(\n    \"list_discovered_resources\"\n)\nlist_resource_evaluations_paginator: ListResourceEvaluationsPaginator = client.get_paginator(\n    \"list_resource_evaluations\"\n)\nlist_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(\n    \"list_tags_for_resource\"\n)\nselect_aggregate_resource_config_paginator: SelectAggregateResourceConfigPaginator = (\n    client.get_paginator(\"select_aggregate_resource_config\")\n)\nselect_resource_config_paginator: SelectResourceConfigPaginator = client.get_paginator(\n    \"select_resource_config\"\n)\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`types_boto3_config.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\nFull list of `ConfigService` Literals can be found in\n[docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/literals/).\n\n```python\nfrom types_boto3_config.literals import AggregateConformancePackComplianceSummaryGroupKeyType\n\n\ndef check_value(value: AggregateConformancePackComplianceSummaryGroupKeyType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`types_boto3_config.type_defs` module contains structures and shapes assembled\nto typed dictionaries and unions for additional type checking.\n\nFull list of `ConfigService` TypeDefs can be found in\n[docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/type_defs/).\n\n```python\nfrom types_boto3_config.type_defs import AccountAggregationSourceOutputTypeDef\n\n\ndef get_value() -> AccountAggregationSourceOutputTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`types-boto3-config` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_config/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for boto3 ConfigService 1.35.71 service generated with mypy-boto3-builder 8.4.0",
    "version": "1.35.71",
    "project_urls": {
        "Documentation": "https://youtype.github.io/types_boto3_docs/types_boto3_config/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "boto3",
        "config",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d6cf766763e17a84df4313c0a03e662b65d660164792e43b16021bc38a3b6237",
                "md5": "9ce574c9232df740ad1ac4d54724eb57",
                "sha256": "dbd4cda84dd72b47a01c6e2d43124c64326a6d7d55c364d5369ccf07c2d0a688"
            },
            "downloads": -1,
            "filename": "types_boto3_config-1.35.71-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ce574c9232df740ad1ac4d54724eb57",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 67430,
            "upload_time": "2024-11-28T01:04:56",
            "upload_time_iso_8601": "2024-11-28T01:04:56.369396Z",
            "url": "https://files.pythonhosted.org/packages/d6/cf/766763e17a84df4313c0a03e662b65d660164792e43b16021bc38a3b6237/types_boto3_config-1.35.71-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-28 01:04:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "types-boto3-config"
}