mypy-boto3-config 1.13.26.1

Type annotations for boto3.ConfigService 1.13.26 service, generated by mypy-boto3-buider 2.0.3

mypy-boto3-config

• mypy-boto3-config
  • How to use
  • Automated type discovery

Type annotations for boto3.ConfigService 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.3.

More information can be found on boto3-stubs page.

• mypy-boto3-config
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for ConfigService service.

python -m pip install boto3-stubs[config]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_config in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_config import ConfigServiceClient

# Now mypy can check if your code is valid.
client: ConfigServiceClient = boto3.client("config")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ConfigServiceClient = session.client("config")



# Annotated paginators are included as well

import mypy_boto3_config.paginator as config_paginators

describe_aggregate_compliance_by_config_rules_paginator: config_paginators.DescribeAggregateComplianceByConfigRulesPaginator = client.get_paginator("describe_aggregate_compliance_by_config_rules")
describe_aggregation_authorizations_paginator: config_paginators.DescribeAggregationAuthorizationsPaginator = client.get_paginator("describe_aggregation_authorizations")
describe_compliance_by_config_rule_paginator: config_paginators.DescribeComplianceByConfigRulePaginator = client.get_paginator("describe_compliance_by_config_rule")
describe_compliance_by_resource_paginator: config_paginators.DescribeComplianceByResourcePaginator = client.get_paginator("describe_compliance_by_resource")
describe_config_rule_evaluation_status_paginator: config_paginators.DescribeConfigRuleEvaluationStatusPaginator = client.get_paginator("describe_config_rule_evaluation_status")
describe_config_rules_paginator: config_paginators.DescribeConfigRulesPaginator = client.get_paginator("describe_config_rules")
describe_configuration_aggregator_sources_status_paginator: config_paginators.DescribeConfigurationAggregatorSourcesStatusPaginator = client.get_paginator("describe_configuration_aggregator_sources_status")
describe_configuration_aggregators_paginator: config_paginators.DescribeConfigurationAggregatorsPaginator = client.get_paginator("describe_configuration_aggregators")
describe_pending_aggregation_requests_paginator: config_paginators.DescribePendingAggregationRequestsPaginator = client.get_paginator("describe_pending_aggregation_requests")
describe_remediation_execution_status_paginator: config_paginators.DescribeRemediationExecutionStatusPaginator = client.get_paginator("describe_remediation_execution_status")
describe_retention_configurations_paginator: config_paginators.DescribeRetentionConfigurationsPaginator = client.get_paginator("describe_retention_configurations")
get_aggregate_compliance_details_by_config_rule_paginator: config_paginators.GetAggregateComplianceDetailsByConfigRulePaginator = client.get_paginator("get_aggregate_compliance_details_by_config_rule")
get_compliance_details_by_config_rule_paginator: config_paginators.GetComplianceDetailsByConfigRulePaginator = client.get_paginator("get_compliance_details_by_config_rule")
get_compliance_details_by_resource_paginator: config_paginators.GetComplianceDetailsByResourcePaginator = client.get_paginator("get_compliance_details_by_resource")
get_resource_config_history_paginator: config_paginators.GetResourceConfigHistoryPaginator = client.get_paginator("get_resource_config_history")
list_aggregate_discovered_resources_paginator: config_paginators.ListAggregateDiscoveredResourcesPaginator = client.get_paginator("list_aggregate_discovered_resources")
list_discovered_resources_paginator: config_paginators.ListDiscoveredResourcesPaginator = client.get_paginator("list_discovered_resources")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_config and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_config as config
from mypy_boto3_config import ConfigServiceClient

# with these
from mypy_boto3 import config
from mypy_boto3.config import ConfigServiceClient