Type annotations for boto3.ServiceCatalog 1.14.14 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-servicecatalog
Type annotations for boto3.ServiceCatalog 1.14.14 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ServiceCatalog
service.
python -m pip install boto3-stubs[servicecatalog]
How to use
Client annotations
ServiceCatalogClient
provides annotations for boto3.client("servicecatalog")
.
import boto3
from mypy_boto3_servicecatalog import ServiceCatalogClient
from mypy_boto3_servicecatalog.paginator import (
ListAcceptedPortfolioSharesPaginator,
ListConstraintsForPortfolioPaginator,
ListLaunchPathsPaginator,
ListOrganizationPortfolioAccessPaginator,
ListPortfoliosForProductPaginator,
ListPortfoliosPaginator,
ListPrincipalsForPortfolioPaginator,
ListProvisionedProductPlansPaginator,
ListProvisioningArtifactsForServiceActionPaginator,
ListRecordHistoryPaginator,
ListResourcesForTagOptionPaginator,
ListServiceActionsForProvisioningArtifactPaginator,
ListServiceActionsPaginator,
ListTagOptionsPaginator,
ScanProvisionedProductsPaginator,
SearchProductsAsAdminPaginator,
)
from mypy_boto3_servicecatalog.type_defs import BudgetDetailTypeDef, ...
client: ServiceCatalogClient = boto3.client("servicecatalog")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ServiceCatalogClient = session.client("servicecatalog")
Paginators annotations
mypy_boto3_servicecatalog.paginator
module contains type annotations for all paginators.
client: ServiceCatalogClient = boto3.client("servicecatalog")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_accepted_portfolio_shares_paginator: ListAcceptedPortfolioSharesPaginator = client.get_paginator("list_accepted_portfolio_shares")
list_constraints_for_portfolio_paginator: ListConstraintsForPortfolioPaginator = client.get_paginator("list_constraints_for_portfolio")
list_launch_paths_paginator: ListLaunchPathsPaginator = client.get_paginator("list_launch_paths")
list_organization_portfolio_access_paginator: ListOrganizationPortfolioAccessPaginator = client.get_paginator("list_organization_portfolio_access")
list_portfolios_paginator: ListPortfoliosPaginator = client.get_paginator("list_portfolios")
list_portfolios_for_product_paginator: ListPortfoliosForProductPaginator = client.get_paginator("list_portfolios_for_product")
list_principals_for_portfolio_paginator: ListPrincipalsForPortfolioPaginator = client.get_paginator("list_principals_for_portfolio")
list_provisioned_product_plans_paginator: ListProvisionedProductPlansPaginator = client.get_paginator("list_provisioned_product_plans")
list_provisioning_artifacts_for_service_action_paginator: ListProvisioningArtifactsForServiceActionPaginator = client.get_paginator("list_provisioning_artifacts_for_service_action")
list_record_history_paginator: ListRecordHistoryPaginator = client.get_paginator("list_record_history")
list_resources_for_tag_option_paginator: ListResourcesForTagOptionPaginator = client.get_paginator("list_resources_for_tag_option")
list_service_actions_paginator: ListServiceActionsPaginator = client.get_paginator("list_service_actions")
list_service_actions_for_provisioning_artifact_paginator: ListServiceActionsForProvisioningArtifactPaginator = client.get_paginator("list_service_actions_for_provisioning_artifact")
list_tag_options_paginator: ListTagOptionsPaginator = client.get_paginator("list_tag_options")
scan_provisioned_products_paginator: ScanProvisionedProductsPaginator = client.get_paginator("scan_provisioned_products")
search_products_as_admin_paginator: SearchProductsAsAdminPaginator = client.get_paginator("search_products_as_admin")
Typed dictionations
mypy_boto3_servicecatalog.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BudgetDetailTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_servicecatalog
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("servicecatalog")
session_client = boto3.Session().client("servicecatalog")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-servicecatalog-1.14.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fa7b60fc96bdac04725745f285cc3fbfd1b1ade1fb8691629e736edd4d0cb83 |
|
MD5 | debd6f5d83f699205252220c45c91455 |
|
BLAKE2b-256 | f3d72be118cbaec1641615fff8ab12c80879874b6e8d73e668fa32e48e91fd0f |
Hashes for mypy_boto3_servicecatalog-1.14.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52eede9eb33fac43b399abfad6a5f73f32d2a3daf36ea10d89e077193a652bf3 |
|
MD5 | 83f6007f6154043dbeee675df7f09c51 |
|
BLAKE2b-256 | 9e10dc8426d0b691694b20cf0f85a87a77baf2a252a5db525140da201138f729 |