Skip to content

ConfigService module#

Index > ConfigService

Auto-generated documentation for ConfigService type annotations stubs module mypy-boto3-config.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ConfigService.

From PyPI with pip#

Install boto3-stubs for ConfigService service.

# 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

How to uninstall#

python -m pip uninstall -y mypy-boto3-config

Usage#

Code samples can be found in Examples.

ConfigServiceClient#

Type annotations and code completion for boto3.client("config") as ConfigServiceClient boto3 documentation

# ConfigServiceClient usage example

from boto3.session import Session

from mypy_boto3_config.client import ConfigServiceClient

def get_client() -> ConfigServiceClient:
    return Session().client("config")

Paginators#

Type annotations and code completion for paginators from boto3.client("config").get_paginator("...").

# DescribeAggregateComplianceByConfigRulesPaginator usage example

from boto3.session import Session

from mypy_boto3_config.paginator import DescribeAggregateComplianceByConfigRulesPaginator

def get_describe_aggregate_compliance_by_config_rules_paginator() -> DescribeAggregateComplianceByConfigRulesPaginator:
    return Session().client("config").get_paginator("describe_aggregate_compliance_by_config_rules"))

Literals#

Type annotations for literals used in methods and schemas.

# AggregateConformancePackComplianceSummaryGroupKeyType usage example

from mypy_boto3_config.literals import AggregateConformancePackComplianceSummaryGroupKeyType

def get_value() -> AggregateConformancePackComplianceSummaryGroupKeyType:
    return "ACCOUNT_ID"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccountAggregationSourceTypeDef usage example

from mypy_boto3_config.type_defs import AccountAggregationSourceTypeDef

def get_value() -> AccountAggregationSourceTypeDef:
    return {
        "AccountIds": ...,
    }