Skip to content

ServiceCatalogClient#

Index > ServiceCatalog > ServiceCatalogClient

Auto-generated documentation for ServiceCatalog type annotations stubs module mypy-boto3-servicecatalog.

ServiceCatalogClient#

Type annotations and code completion for boto3.client("servicecatalog"). boto3 documentation

# ServiceCatalogClient usage example

from boto3.session import Session
from mypy_boto3_servicecatalog.client import ServiceCatalogClient

def get_servicecatalog_client() -> ServiceCatalogClient:
    return Session().client("servicecatalog")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("servicecatalog").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("servicecatalog")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DuplicateResourceException,
    client.exceptions.InvalidParametersException,
    client.exceptions.InvalidStateException,
    client.exceptions.LimitExceededException,
    client.exceptions.OperationNotSupportedException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TagOptionNotMigratedException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_servicecatalog.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

accept_portfolio_share#

Accepts an offer to share the specified portfolio.

Type annotations and code completion for boto3.client("servicecatalog").accept_portfolio_share method. boto3 documentation

# accept_portfolio_share method definition

def accept_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    PortfolioShareType: PortfolioShareTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See PortfolioShareTypeType
# accept_portfolio_share method usage example with argument unpacking

kwargs: AcceptPortfolioShareInputRequestTypeDef = {  # (1)
    "PortfolioId": ...,
}

parent.accept_portfolio_share(**kwargs)
  1. See AcceptPortfolioShareInputRequestTypeDef

associate_budget_with_resource#

Associates the specified budget with the specified resource.

Type annotations and code completion for boto3.client("servicecatalog").associate_budget_with_resource method. boto3 documentation

# associate_budget_with_resource method definition

def associate_budget_with_resource(
    self,
    *,
    BudgetName: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...
# associate_budget_with_resource method usage example with argument unpacking

kwargs: AssociateBudgetWithResourceInputRequestTypeDef = {  # (1)
    "BudgetName": ...,
    "ResourceId": ...,
}

parent.associate_budget_with_resource(**kwargs)
  1. See AssociateBudgetWithResourceInputRequestTypeDef

associate_principal_with_portfolio#

Associates the specified principal ARN with the specified portfolio.

Type annotations and code completion for boto3.client("servicecatalog").associate_principal_with_portfolio method. boto3 documentation

# associate_principal_with_portfolio method definition

def associate_principal_with_portfolio(
    self,
    *,
    PortfolioId: str,
    PrincipalARN: str,
    PrincipalType: PrincipalTypeType,  # (1)
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...
  1. See PrincipalTypeType
# associate_principal_with_portfolio method usage example with argument unpacking

kwargs: AssociatePrincipalWithPortfolioInputRequestTypeDef = {  # (1)
    "PortfolioId": ...,
    "PrincipalARN": ...,
    "PrincipalType": ...,
}

parent.associate_principal_with_portfolio(**kwargs)
  1. See AssociatePrincipalWithPortfolioInputRequestTypeDef

associate_product_with_portfolio#

Associates the specified product with the specified portfolio.

Type annotations and code completion for boto3.client("servicecatalog").associate_product_with_portfolio method. boto3 documentation

# associate_product_with_portfolio method definition

def associate_product_with_portfolio(
    self,
    *,
    ProductId: str,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    SourcePortfolioId: str = ...,
) -> Dict[str, Any]:
    ...
# associate_product_with_portfolio method usage example with argument unpacking

kwargs: AssociateProductWithPortfolioInputRequestTypeDef = {  # (1)
    "ProductId": ...,
    "PortfolioId": ...,
}

parent.associate_product_with_portfolio(**kwargs)
  1. See AssociateProductWithPortfolioInputRequestTypeDef

associate_service_action_with_provisioning_artifact#

Associates a self-service action with a provisioning artifact.

Type annotations and code completion for boto3.client("servicecatalog").associate_service_action_with_provisioning_artifact method. boto3 documentation

# associate_service_action_with_provisioning_artifact method definition

def associate_service_action_with_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    ServiceActionId: str,
    AcceptLanguage: str = ...,
    IdempotencyToken: str = ...,
) -> Dict[str, Any]:
    ...
# associate_service_action_with_provisioning_artifact method usage example with argument unpacking

kwargs: AssociateServiceActionWithProvisioningArtifactInputRequestTypeDef = {  # (1)
    "ProductId": ...,
    "ProvisioningArtifactId": ...,
    "ServiceActionId": ...,
}

parent.associate_service_action_with_provisioning_artifact(**kwargs)
  1. See AssociateServiceActionWithProvisioningArtifactInputRequestTypeDef

associate_tag_option_with_resource#

Associate the specified TagOption with the specified portfolio or product.

Type annotations and code completion for boto3.client("servicecatalog").associate_tag_option_with_resource method. boto3 documentation

# associate_tag_option_with_resource method definition

def associate_tag_option_with_resource(
    self,
    *,
    ResourceId: str,
    TagOptionId: str,
) -> Dict[str, Any]:
    ...
# associate_tag_option_with_resource method usage example with argument unpacking

kwargs: AssociateTagOptionWithResourceInputRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "TagOptionId": ...,
}

parent.associate_tag_option_with_resource(**kwargs)
  1. See AssociateTagOptionWithResourceInputRequestTypeDef

batch_associate_service_action_with_provisioning_artifact#

Associates multiple self-service actions with provisioning artifacts.

Type annotations and code completion for boto3.client("servicecatalog").batch_associate_service_action_with_provisioning_artifact method. boto3 documentation

# batch_associate_service_action_with_provisioning_artifact method definition

def batch_associate_service_action_with_provisioning_artifact(
    self,
    *,
    ServiceActionAssociations: Sequence[ServiceActionAssociationTypeDef],  # (1)
    AcceptLanguage: str = ...,
) -> BatchAssociateServiceActionWithProvisioningArtifactOutputTypeDef:  # (2)
    ...
  1. See ServiceActionAssociationTypeDef
  2. See BatchAssociateServiceActionWithProvisioningArtifactOutputTypeDef
# batch_associate_service_action_with_provisioning_artifact method usage example with argument unpacking

kwargs: BatchAssociateServiceActionWithProvisioningArtifactInputRequestTypeDef = {  # (1)
    "ServiceActionAssociations": ...,
}

parent.batch_associate_service_action_with_provisioning_artifact(**kwargs)
  1. See BatchAssociateServiceActionWithProvisioningArtifactInputRequestTypeDef

batch_disassociate_service_action_from_provisioning_artifact#

Disassociates a batch of self-service actions from the specified provisioning artifact.

Type annotations and code completion for boto3.client("servicecatalog").batch_disassociate_service_action_from_provisioning_artifact method. boto3 documentation

# batch_disassociate_service_action_from_provisioning_artifact method definition

def batch_disassociate_service_action_from_provisioning_artifact(
    self,
    *,
    ServiceActionAssociations: Sequence[ServiceActionAssociationTypeDef],  # (1)
    AcceptLanguage: str = ...,
) -> BatchDisassociateServiceActionFromProvisioningArtifactOutputTypeDef:  # (2)
    ...
  1. See ServiceActionAssociationTypeDef
  2. See BatchDisassociateServiceActionFromProvisioningArtifactOutputTypeDef
# batch_disassociate_service_action_from_provisioning_artifact method usage example with argument unpacking

kwargs: BatchDisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef = {  # (1)
    "ServiceActionAssociations": ...,
}

parent.batch_disassociate_service_action_from_provisioning_artifact(**kwargs)
  1. See BatchDisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("servicecatalog").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("servicecatalog").close method.