ServiceCatalog module#
Index > ServiceCatalog
Auto-generated documentation for ServiceCatalog type annotations stubs module mypy-boto3-servicecatalog.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
ServiceCatalog
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ServiceCatalog
.
From PyPI with pip#
Install boto3-stubs
for ServiceCatalog
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[servicecatalog]'
# 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[servicecatalog]'
# standalone installation
python -m pip install mypy-boto3-servicecatalog
How to uninstall#
python -m pip uninstall -y mypy-boto3-servicecatalog
Usage#
Code samples can be found in Examples.
ServiceCatalogClient#
Type annotations and code completion for boto3.client("servicecatalog")
as ServiceCatalogClient
boto3 documentation
# ServiceCatalogClient usage example
from boto3.session import Session
from mypy_boto3_servicecatalog.client import ServiceCatalogClient
def get_client() -> ServiceCatalogClient:
return Session().client("servicecatalog")
Paginators#
Type annotations and code completion for paginators
from boto3.client("servicecatalog").get_paginator("...")
.
# ListAcceptedPortfolioSharesPaginator usage example
from boto3.session import Session
from mypy_boto3_servicecatalog.paginator import ListAcceptedPortfolioSharesPaginator
def get_list_accepted_portfolio_shares_paginator() -> ListAcceptedPortfolioSharesPaginator:
return Session().client("servicecatalog").get_paginator("list_accepted_portfolio_shares"))
- ListAcceptedPortfolioSharesPaginator
- ListConstraintsForPortfolioPaginator
- ListLaunchPathsPaginator
- ListOrganizationPortfolioAccessPaginator
- ListPortfoliosForProductPaginator
- ListPortfoliosPaginator
- ListPrincipalsForPortfolioPaginator
- ListProvisionedProductPlansPaginator
- ListProvisioningArtifactsForServiceActionPaginator
- ListRecordHistoryPaginator
- ListResourcesForTagOptionPaginator
- ListServiceActionsForProvisioningArtifactPaginator
- ListServiceActionsPaginator
- ListTagOptionsPaginator
- ScanProvisionedProductsPaginator
- SearchProductsAsAdminPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccessLevelFilterKeyType usage example
from mypy_boto3_servicecatalog.literals import AccessLevelFilterKeyType
def get_value() -> AccessLevelFilterKeyType:
return "Account"
- AccessLevelFilterKeyType
- AccessStatusType
- ChangeActionType
- CopyOptionType
- CopyProductStatusType
- DescribePortfolioShareTypeType
- EngineWorkflowStatusType
- EvaluationTypeType
- LastSyncStatusType
- ListAcceptedPortfolioSharesPaginatorName
- ListConstraintsForPortfolioPaginatorName
- ListLaunchPathsPaginatorName
- ListOrganizationPortfolioAccessPaginatorName
- ListPortfoliosForProductPaginatorName
- ListPortfoliosPaginatorName
- ListPrincipalsForPortfolioPaginatorName
- ListProvisionedProductPlansPaginatorName
- ListProvisioningArtifactsForServiceActionPaginatorName
- ListRecordHistoryPaginatorName
- ListResourcesForTagOptionPaginatorName
- ListServiceActionsForProvisioningArtifactPaginatorName
- ListServiceActionsPaginatorName
- ListTagOptionsPaginatorName
- OrganizationNodeTypeType
- PortfolioShareTypeType
- PrincipalTypeType
- ProductSourceType
- ProductTypeType
- ProductViewFilterByType
- ProductViewSortByType
- PropertyKeyType
- ProvisionedProductPlanStatusType
- ProvisionedProductPlanTypeType
- ProvisionedProductStatusType
- ProvisionedProductViewFilterByType
- ProvisioningArtifactGuidanceType
- ProvisioningArtifactPropertyNameType
- ProvisioningArtifactTypeType
- RecordStatusType
- ReplacementType
- RequiresRecreationType
- ResourceAttributeType
- ScanProvisionedProductsPaginatorName
- SearchProductsAsAdminPaginatorName
- ServiceActionAssociationErrorCodeType
- ServiceActionDefinitionKeyType
- ServiceActionDefinitionTypeType
- ShareStatusType
- SortOrderType
- SourceTypeType
- StackInstanceStatusType
- StackSetOperationTypeType
- StatusType
- ServiceCatalogServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcceptPortfolioShareInputRequestTypeDef
- AccessLevelFilterTypeDef
- AssociateBudgetWithResourceInputRequestTypeDef
- AssociatePrincipalWithPortfolioInputRequestTypeDef
- AssociateProductWithPortfolioInputRequestTypeDef
- AssociateServiceActionWithProvisioningArtifactInputRequestTypeDef
- AssociateTagOptionWithResourceInputRequestTypeDef
- ServiceActionAssociationTypeDef
- FailedServiceActionAssociationTypeDef
- ResponseMetadataTypeDef
- BudgetDetailTypeDef
- CloudWatchDashboardTypeDef
- CodeStarParametersTypeDef
- ConstraintDetailTypeDef
- ConstraintSummaryTypeDef
- CopyProductInputRequestTypeDef
- CreateConstraintInputRequestTypeDef
- TagTypeDef
- PortfolioDetailTypeDef
- OrganizationNodeTypeDef
- ProvisioningArtifactPropertiesTypeDef
- ProvisioningArtifactDetailTypeDef
- UpdateProvisioningParameterTypeDef
- CreateServiceActionInputRequestTypeDef
- CreateTagOptionInputRequestTypeDef
- TagOptionDetailTypeDef
- DeleteConstraintInputRequestTypeDef
- DeletePortfolioInputRequestTypeDef
- DeleteProductInputRequestTypeDef
- DeleteProvisionedProductPlanInputRequestTypeDef
- DeleteProvisioningArtifactInputRequestTypeDef
- DeleteServiceActionInputRequestTypeDef
- DeleteTagOptionInputRequestTypeDef
- DescribeConstraintInputRequestTypeDef
- DescribeCopyProductStatusInputRequestTypeDef
- DescribePortfolioInputRequestTypeDef
- DescribePortfolioShareStatusInputRequestTypeDef
- DescribePortfolioSharesInputRequestTypeDef
- PortfolioShareDetailTypeDef
- DescribeProductAsAdminInputRequestTypeDef
- ProvisioningArtifactSummaryTypeDef
- DescribeProductInputRequestTypeDef
- LaunchPathTypeDef
- ProductViewSummaryTypeDef
- ProvisioningArtifactTypeDef
- DescribeProductViewInputRequestTypeDef
- DescribeProvisionedProductInputRequestTypeDef
- ProvisionedProductDetailTypeDef
- DescribeProvisionedProductPlanInputRequestTypeDef
- DescribeProvisioningArtifactInputRequestTypeDef
- DescribeProvisioningParametersInputRequestTypeDef
- ProvisioningArtifactOutputTypeDef
- ProvisioningArtifactPreferencesTypeDef
- TagOptionSummaryTypeDef
- UsageInstructionTypeDef
- DescribeRecordInputRequestTypeDef
- RecordOutputTypeDef
- DescribeServiceActionExecutionParametersInputRequestTypeDef
- ExecutionParameterTypeDef
- DescribeServiceActionInputRequestTypeDef
- DescribeTagOptionInputRequestTypeDef
- DisassociateBudgetFromResourceInputRequestTypeDef
- DisassociatePrincipalFromPortfolioInputRequestTypeDef
- DisassociateProductFromPortfolioInputRequestTypeDef
- DisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef
- DisassociateTagOptionFromResourceInputRequestTypeDef
- UniqueTagResourceIdentifierTypeDef
- ExecuteProvisionedProductPlanInputRequestTypeDef
- ExecuteProvisionedProductServiceActionInputRequestTypeDef
- GetProvisionedProductOutputsInputRequestTypeDef
- ImportAsProvisionedProductInputRequestTypeDef
- LastSyncTypeDef
- PaginatorConfigTypeDef
- ListAcceptedPortfolioSharesInputRequestTypeDef
- ListBudgetsForResourceInputRequestTypeDef
- ListConstraintsForPortfolioInputRequestTypeDef
- ListLaunchPathsInputRequestTypeDef
- ListOrganizationPortfolioAccessInputRequestTypeDef
- ListPortfolioAccessInputRequestTypeDef
- ListPortfoliosForProductInputRequestTypeDef
- ListPortfoliosInputRequestTypeDef
- ListPrincipalsForPortfolioInputRequestTypeDef
- PrincipalTypeDef
- ProvisionedProductPlanSummaryTypeDef
- ListProvisioningArtifactsForServiceActionInputRequestTypeDef
- ListProvisioningArtifactsInputRequestTypeDef
- ListRecordHistorySearchFilterTypeDef
- ListResourcesForTagOptionInputRequestTypeDef
- ResourceDetailTypeDef
- ListServiceActionsForProvisioningArtifactInputRequestTypeDef
- ServiceActionSummaryTypeDef
- ListServiceActionsInputRequestTypeDef
- ListStackInstancesForProvisionedProductInputRequestTypeDef
- StackInstanceTypeDef
- ListTagOptionsFiltersTypeDef
- NotifyTerminateProvisionedProductEngineWorkflowResultInputRequestTypeDef
- ParameterConstraintsTypeDef
- ProductViewAggregationValueTypeDef
- ProvisioningParameterTypeDef
- ProvisioningPreferencesTypeDef
- RecordErrorTypeDef
- RecordTagTypeDef
- RejectPortfolioShareInputRequestTypeDef
- ResourceTargetDefinitionTypeDef
- SearchProductsAsAdminInputRequestTypeDef
- SearchProductsInputRequestTypeDef
- ShareErrorTypeDef
- TerminateProvisionedProductInputRequestTypeDef
- UpdateConstraintInputRequestTypeDef
- UpdateProvisioningPreferencesTypeDef
- UpdateProvisionedProductPropertiesInputRequestTypeDef
- UpdateProvisioningArtifactInputRequestTypeDef
- UpdateServiceActionInputRequestTypeDef
- UpdateTagOptionInputRequestTypeDef
- ListProvisionedProductPlansInputRequestTypeDef
- ScanProvisionedProductsInputRequestTypeDef
- SearchProvisionedProductsInputRequestTypeDef
- BatchAssociateServiceActionWithProvisioningArtifactInputRequestTypeDef
- BatchDisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef
- BatchAssociateServiceActionWithProvisioningArtifactOutputTypeDef
- BatchDisassociateServiceActionFromProvisioningArtifactOutputTypeDef
- CopyProductOutputTypeDef
- CreatePortfolioShareOutputTypeDef
- CreateProvisionedProductPlanOutputTypeDef
- DeletePortfolioShareOutputTypeDef
- DescribeCopyProductStatusOutputTypeDef
- GetAWSOrganizationsAccessStatusOutputTypeDef
- ListPortfolioAccessOutputTypeDef
- UpdatePortfolioShareOutputTypeDef
- UpdateProvisionedProductPropertiesOutputTypeDef
- ListBudgetsForResourceOutputTypeDef
- SourceConnectionParametersTypeDef
- CreateConstraintOutputTypeDef
- DescribeConstraintOutputTypeDef
- ListConstraintsForPortfolioOutputTypeDef
- UpdateConstraintOutputTypeDef
- CreatePortfolioInputRequestTypeDef
- LaunchPathSummaryTypeDef
- ProvisionedProductAttributeTypeDef
- UpdatePortfolioInputRequestTypeDef
- CreatePortfolioOutputTypeDef
- ListAcceptedPortfolioSharesOutputTypeDef
- ListPortfoliosForProductOutputTypeDef
- ListPortfoliosOutputTypeDef
- UpdatePortfolioOutputTypeDef
- CreatePortfolioShareInputRequestTypeDef
- DeletePortfolioShareInputRequestTypeDef
- ListOrganizationPortfolioAccessOutputTypeDef
- UpdatePortfolioShareInputRequestTypeDef
- CreateProvisioningArtifactInputRequestTypeDef
- CreateProvisioningArtifactOutputTypeDef
- ListProvisioningArtifactsOutputTypeDef
- UpdateProvisioningArtifactOutputTypeDef
- CreateProvisionedProductPlanInputRequestTypeDef
- ProvisionedProductPlanDetailsTypeDef
- CreateTagOptionOutputTypeDef
- DescribePortfolioOutputTypeDef
- DescribeTagOptionOutputTypeDef
- ListTagOptionsOutputTypeDef
- UpdateTagOptionOutputTypeDef
- DescribePortfolioSharesOutputTypeDef
- DescribeProductOutputTypeDef
- DescribeProductViewOutputTypeDef
- ProvisioningArtifactViewTypeDef
- DescribeProvisionedProductOutputTypeDef
- ScanProvisionedProductsOutputTypeDef
- GetProvisionedProductOutputsOutputTypeDef
- NotifyUpdateProvisionedProductEngineWorkflowResultInputRequestTypeDef
- DescribeServiceActionExecutionParametersOutputTypeDef
- EngineWorkflowResourceIdentifierTypeDef
- ListAcceptedPortfolioSharesInputPaginateTypeDef
- ListConstraintsForPortfolioInputPaginateTypeDef
- ListLaunchPathsInputPaginateTypeDef
- ListOrganizationPortfolioAccessInputPaginateTypeDef
- ListPortfoliosForProductInputPaginateTypeDef
- ListPortfoliosInputPaginateTypeDef
- ListPrincipalsForPortfolioInputPaginateTypeDef
- ListProvisionedProductPlansInputPaginateTypeDef
- ListProvisioningArtifactsForServiceActionInputPaginateTypeDef
- ListResourcesForTagOptionInputPaginateTypeDef
- ListServiceActionsForProvisioningArtifactInputPaginateTypeDef
- ListServiceActionsInputPaginateTypeDef
- ScanProvisionedProductsInputPaginateTypeDef
- SearchProductsAsAdminInputPaginateTypeDef
- ListPrincipalsForPortfolioOutputTypeDef
- ListProvisionedProductPlansOutputTypeDef
- ListRecordHistoryInputPaginateTypeDef
- ListRecordHistoryInputRequestTypeDef
- ListResourcesForTagOptionOutputTypeDef
- ListServiceActionsForProvisioningArtifactOutputTypeDef
- ListServiceActionsOutputTypeDef
- ServiceActionDetailTypeDef
- ListStackInstancesForProvisionedProductOutputTypeDef
- ListTagOptionsInputPaginateTypeDef
- ListTagOptionsInputRequestTypeDef
- ProvisioningArtifactParameterTypeDef
- SearchProductsOutputTypeDef
- ProvisionProductInputRequestTypeDef
- RecordDetailTypeDef
- ResourceChangeDetailTypeDef
- ShareDetailsTypeDef
- UpdateProvisionedProductInputRequestTypeDef
- SourceConnectionDetailTypeDef
- SourceConnectionTypeDef
- ListLaunchPathsOutputTypeDef
- SearchProvisionedProductsOutputTypeDef
- ListProvisioningArtifactsForServiceActionOutputTypeDef
- NotifyProvisionProductEngineWorkflowResultInputRequestTypeDef
- CreateServiceActionOutputTypeDef
- DescribeServiceActionOutputTypeDef
- UpdateServiceActionOutputTypeDef
- DescribeProvisioningArtifactOutputTypeDef
- DescribeProvisioningParametersOutputTypeDef
- DescribeRecordOutputTypeDef
- ExecuteProvisionedProductPlanOutputTypeDef
- ExecuteProvisionedProductServiceActionOutputTypeDef
- ImportAsProvisionedProductOutputTypeDef
- ListRecordHistoryOutputTypeDef
- ProvisionProductOutputTypeDef
- TerminateProvisionedProductOutputTypeDef
- UpdateProvisionedProductOutputTypeDef
- ResourceChangeTypeDef
- DescribePortfolioShareStatusOutputTypeDef
- ProductViewDetailTypeDef
- CreateProductInputRequestTypeDef
- UpdateProductInputRequestTypeDef
- DescribeProvisionedProductPlanOutputTypeDef
- CreateProductOutputTypeDef
- DescribeProductAsAdminOutputTypeDef
- SearchProductsAsAdminOutputTypeDef
- UpdateProductOutputTypeDef